diff --git a/marked/Rel-18/32_series/32103/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg b/marked/Rel-18/32_series/32103/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8f1487c90711ebdefb0deac4324aa00b8d7cb006 --- /dev/null +++ b/marked/Rel-18/32_series/32103/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c853cde1b1c83d54bb1019a49789ebe518a8df215d50347c31baf5978b4f106b +size 185869 diff --git a/marked/Rel-18/32_series/32103/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32103/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8cec23f6e213b241f2742386263d844cd350c779 --- /dev/null +++ b/marked/Rel-18/32_series/32103/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d7cf3e5bf93395cbe4d2cf205a204755b538a8569505f6ecc00ed5f61e324a2 +size 9730 diff --git a/marked/Rel-18/32_series/32103/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32103/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b49652b622b042b7b8eadc71fc663bfbfde09de2 --- /dev/null +++ b/marked/Rel-18/32_series/32103/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fd440a56cf5a990399182991e89e31f205c6dc22ea197fb430bba86b872db36 +size 6042 diff --git a/marked/Rel-18/32_series/32103/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg b/marked/Rel-18/32_series/32103/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a15d5e26edd72d47618aecb2f165abb8b8a2c89 --- /dev/null +++ b/marked/Rel-18/32_series/32103/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d7dfcb4ce10dcebab97d53adf0113b23c3f2694b3ef7b4a0502f8248e14d20bf +size 80484 diff --git a/marked/Rel-18/32_series/32103/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg b/marked/Rel-18/32_series/32103/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c7858f08560ac6dabc552098653edd5a360480c --- /dev/null +++ b/marked/Rel-18/32_series/32103/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:974763d9baf0fbcfbde2024952e7961e9e60c1ace286a736a8305dbf0ccc234e +size 121134 diff --git a/marked/Rel-18/32_series/32103/98e54d5540b2efe3e24af3cf936bc4ea_img.jpg b/marked/Rel-18/32_series/32103/98e54d5540b2efe3e24af3cf936bc4ea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9314b7d3e99b76b5ee9f03241f1bfc8b0ea520be --- /dev/null +++ b/marked/Rel-18/32_series/32103/98e54d5540b2efe3e24af3cf936bc4ea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c779533e961d6ace2b46285b30a7372c06e7afa87a27f88e29608c3e7392986d +size 119499 diff --git a/marked/Rel-18/32_series/32103/a4b963a07cc368283154762c4b156fe7_img.jpg b/marked/Rel-18/32_series/32103/a4b963a07cc368283154762c4b156fe7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e1eccb1f37e8eaf036ea26c85073191fe217f092 --- /dev/null +++ b/marked/Rel-18/32_series/32103/a4b963a07cc368283154762c4b156fe7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:75a76968e27d7c15113aade0346569eb7cabf3c6b722f6047ee4187d95a05072 +size 50554 diff --git a/marked/Rel-18/32_series/32103/d9c0a780cd22626253dab4aa41699e2f_img.jpg b/marked/Rel-18/32_series/32103/d9c0a780cd22626253dab4aa41699e2f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aa5f7358ce71fc8955f8a0eec1878ee71d2c0ba7 --- /dev/null +++ b/marked/Rel-18/32_series/32103/d9c0a780cd22626253dab4aa41699e2f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59ae9dbf2c2c8bdc2396f1c583937672bf6eceb93ae582fbb84317cf196873f0 +size 133655 diff --git a/marked/Rel-18/32_series/32103/raw.md b/marked/Rel-18/32_series/32103/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..df8f11f2ad906ad1d61f45165c3d25e3f51e606f --- /dev/null +++ b/marked/Rel-18/32_series/32103/raw.md @@ -0,0 +1,1492 @@ + + +# 3GPP TS 32.103 V18.0.0 (2024-04) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Integration Reference Point (IRP) overview and usage guide (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +## --- **Keywords** + +--- + +IRP, IF IRP, NRM IRP + +## **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. + +© 2024, 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 ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 15 | +| 3.1 Definitions..... | 15 | +| 3.2 Abbreviations ..... | 16 | +| 4 IRP Framework..... | 17 | +| 4.1 Introduction ..... | 17 | +| 4.2 IRP Framework Highlights ..... | 18 | +| 4.2.1 IRP Concept..... | 18 | +| 4.2.2 Relationships between IRPs ..... | 19 | +| 4.2.3 IRP Development Principles ..... | 20 | +| 4.2.4 IRP Specification Structure ..... | 20 | +| 4.2.5 Void..... | 21 | +| 4.3 IRP related High-level Requirements & Architecture Specifications..... | 21 | +| 4.4 Converged Management and IRPs..... | 22 | +| 5 Interface IRPs..... | 23 | +| 5.1 Interface IRP Overview..... | 23 | +| 5.2 Generic/Common Interface IRPs ..... | 23 | +| 5.3 FM related interface IRPs ..... | 24 | +| 5.4 CM related interface IRPs..... | 24 | +| 5.5 PM file format/collection & Trace related Interface IRPs ..... | 25 | +| 5.6 Special-purpose related Interface IRPs ..... | 25 | +| 5.7 SON related Interface IRPs..... | 26 | +| 6 NRM IRPs..... | 27 | +| 6.1 NRM IRP Overview..... | 27 | +| 6.2 FMC Models and Common NRM IRPs..... | 27 | +| 6.3 Access Network (AN) related NRM IRPs ..... | 28 | +| 6.4 Core Network (CN)/IMS related NRM IRPs..... | 28 | +| 6.5 H(e)NB related NRM IRPs ..... | 28 | +| 6.6 Service management related NRM IRPs and UDC specifications ..... | 29 | +| 6.7 Special-purpose related NRM IRPs ..... | 30 | +| 6.8 EPC interworking with non-3GPP access NRM IRPs..... | 30 | +| 7 Measurement & Trace Definitions..... | 31 | +| 7.1 Performance Measurements ..... | 31 | +| 7.1.1 Overview and relationships to IRP Framework ..... | 31 | +| 7.1.2 Performance Measurement Specifications ..... | 32 | +| 7.2 Trace Specifications..... | 34 | +| 7.2.1 Overview and relationships to IRP Framework ..... | 34 | +| 7.2.2 Trace Specifications ..... | 34 | +| 7.3 QoE measurements..... | 35 | +| 7.3.1 Overview and relationships to management services..... | 35 | +| 7.3.2 QoE specifications..... | 35 | +| 8 Relationships between IRPs..... | 37 | +| 9 SON functions..... | 38 | +| 10 Network Function Virtualization (NFV)..... | 41 | +| 10.1 Overview ..... | 41 | + +11 Void..... 43 + +**Annex A (Informative): Void ..... 44** + +**Annex B (normative): Features supported ..... 45** + +B.1 Converged management support table..... 45 + +B.2 Network sharing management support table..... 47 + +**Annex C (informative): Change history..... 54** + +# --- 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 provides the IRP Overview for 3GPP specifications, addressing Interface IRPs, NRM IRPs, Measurement / Trace /SON specifications, as well as their relationships with each other. + +# --- 1 Scope + +The present document gives an overview about 3GPP's management capabilities and related functionality. This document is intended to be a guide into the world of 3GPP management specifications, enabling also non-subject matter experts to gain an understanding about 3GPP's management solutions. + +# --- 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 32.101: "Telecommunication management; Principles and high level requirements". +- [4] 3GPP TS 28.624: "Telecommunication management; State management data definition Integration Reference Point (IRP); Requirements". +- [5] 3GPP TS 28.625: "Telecommunication management; State management data definition Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 28.626: "Telecommunication management; State management data definition Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.601: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Requirements". +- [8] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Information Service (IS)". +- [9] 3GPP TS 32.603: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Common Object Request Broker Architecture (CORBA) Solution Set (SS)". +- [10] 3GPP TS 28.621: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [11] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [12] 3GPP TS 28.623: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [13] Void +- [14] Void + +- [15] 3GPP TS 32.153: "Telecommunication management; Integration Reference Point (IRP) technology specific templates, rules and guidelines". +- [16] 3GPP TS 32.154: "Telecommunication management; Backward and Forward Compatibility (BFC); Concept and definitions". +- [17] 3GPP TS 32.155: "Telecommunication management; Requirements template". +- [18] 3GPP TS 32.156: "Telecommunication management; Fixed Mobile Convergence (FMC) model repertoire". +- [19] 3GPP TS 32.157: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template". +- [20] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [21] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [22] 3GPP TS 32.111-1: "Telecommunication management; Fault Management; Part 1: 3G fault management requirements". +- [23] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) requirements". +- [24] 3GPP TS 32.141: "Telecommunication management; Subscription Management (SuM) architecture". +- [25] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [26] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements". +- [27] 3GPP TS 32.500: "Telecommunication management; Self-Organizing Networks (SON); Concepts and requirements". +- [28] 3GPP TS 32.511: "Telecommunication management; Automatic Neighbour Relation (ANR) management; Concepts and requirements". +- [29] 3GPP TS 32.521: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [30] 3GPP TS 32.541: "Telecommunication management; Self-Organizing Networks (SON); Self-healing concepts and requirements". +- [31] 3GPP TS 32.551: "Telecommunication management; Energy Saving Management (ESM); Concepts and requirements". +- [32] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [33] Void +- [34] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [35] 3GPP TS 28.627: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [36] 3GPP TS 32.501: "Telecommunication management; Self-configuration of network elements; Concepts and requirements". +- [37] 3GPP TS 32.421: "Telecommunication management; Subscriber and equipment trace; Trace concepts and requirements". + +- [38] 3GPP TS 32.441: "Telecommunication management; Trace Management Integration Reference Point (IRP); Requirements". +- [42] Void +- [43] Void +- [44] Void +- [45] Void +- [46] Void +- [47] Void +- [48] Void +- [49] Void +- [50] Void +- [51] Void +- [52] Void +- [53] Void . +- [54] Void +- [55] Void +- [56] Void +- [57] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management ". +- [58] 3GPP TS 28.404: "Telecommunication management; Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements". +- [59] 3GPP TS 28.405: "Management of Quality of Experience (QoE) measurement collection; Control and configuration". +- [60] 3GPP TS 28.406: "Management of Quality of Experience (QoE) measurement collection; Information definition and transport". +- [61] 3GPP TS 28.402: "Telecommunication management; Performance Management (PM); Performance measurements for Evolved Packet Core (EPC) and non-3GPP access interworking system". +- [62] 3GPP TS 28.403: "Telecommunication management; Performance Management (PM); Performance measurements for Wireless Local Area Network (WLAN)". +- [63] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [64] 3GPP TS 32.111-6: "Telecommunication management; Fault Management; Part 6: Alarm Integration Reference Point (IRP): Solution Set (SS) definitions". +- [65] 3GPP TS 32.121: "Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP): Requirements". +- [66] 3GPP TS 32.122: "Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP): Information Service (IS)". +- [67] 3GPP TS 32.126: "Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +- [68] 3GPP TS 32.301: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Requirements". +- [69] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)". +- [70] 3GPP TS 32.306: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Solution Set (SS) definitions". +- [71] 3GPP TS 32.311: "Telecommunication management; Generic Integration Reference Point (IRP) management; Requirements". +- [72] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)". +- [73] 3GPP TS 32.316: "Telecommunication management; Generic Integration Reference Point (IRP) management; Solution Set (SS) definitions". +- [74] 3GPP TS 32.321: "Telecommunication management; Test management Integration Reference Point (IRP); Requirements". +- [75] 3GPP TS 32.322: "Telecommunication management; Test management Integration Reference Point (IRP); Information Service (IS) ". +- [76] 3GPP TS 32.326: "Telecommunication management; Test management Integration Reference Point (IRP): Solution Set (SS) definitions". +- [77] 3GPP TS 32.331: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP); Requirements", +- [78] 3GPP TS 32.332: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP); Information Service (IS)". +- [79] 3GPP TS 32.336: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): Solution Set (SS) definitions". +- [80] 3GPP TS 32.341: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP); Requirements". +- [81] 3GPP TS 32.342: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP); Information Service (IS)". +- [82] 3GPP TS 32.346: "Telecommunication management; File Transfer (FT) Integration ReferencePoint (IRP): Solution Set (SS) definitions". +- [83] 3GPP TS 32.351: "Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP); Requirements". +- [84] 3GPP TS 32.352: "Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP); Information Service (IS)". +- [85] 3GPP TS 32.356: "Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [86] 3GPP TS 32.361: "Telecommunication management; Entry Point (EP) Integration Reference Point (IRP); Requirements". +- [87] 3GPP TS 32.362: "Telecommunication management; Entry Point (EP) Integration Reference Point (IRP); Information Service (IS)". +- [88] 3GPP TS 32.366: "Telecommunication management; Entry Point (EP) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [89] 3GPP TS 32.381: "Telecommunication management; Partial Suspension of Itf-N Integration Reference Point (IRP); Requirements". + +- [90] 3GPP TS 32.382: "Telecommunication management; Partial Suspension of Itf-N Integration Reference Point (IRP); Information Service (IS)". +- [91] 3GPP TS 32.386: "Telecommunication management; Partial Suspension of Itf-N Integration Reference Point (IRP); Solution Set (SS) definitions". +- [92] 3GPP TS 32.391: "Telecommunication management; Delta synchronization Integration Reference Point (IRP); Requirements". +- [93] 3GPP TS 32.392: "Telecommunication management; Delta synchronization Integration Reference Point (IRP); Information Service (IS)". +- [94] 3GPP TS 32.396: "Telecommunication management; Delta synchronization Integration Reference Point (IRP); Solution Set (SS) definitions". +- [95] 3GPP TS 32.405: "Telecommunication management; Performance Management (PM); Performance measurements; Universal Terrestrial Radio Access Network (UTRAN)". +- [96] 3GPP TS 32.406: "Telecommunication management; Performance Management (PM); Performance measurements; Core Network (CN) Packet Switched (PS) domain". +- [97] 3GPP TS 32.407: "Telecommunication management; Performance Management (PM); Performance measurements; Core Network (CN) Circuit Switched (CS) domain; UMTS and combined UMTS/GSM". +- [98] 3GPP TS 32.408: "Telecommunication management; Performance Management (PM); Performance measurements; Teleservice". +- [99] 3GPP TS 32.409: "Telecommunication management; Performance Management (PM); Performance measurements; IP Multimedia Subsystem (IMS)". +- [100] 3GPP TS 32.410: "Telecommunication management; Key Performance Indicators (KPI) for UMTS and GSM". +- [101] 3GPP TS 32.411: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Requirements". +- [102] 3GPP TS 32.412: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Information Service (IS)". +- [103] 3GPP TS 32.416: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [104] 3GPP TS 32.423: "Telecommunication management; Subscriber and equipment trace; Trace data definition and management +- [105] 3GPP TS 32.425: "Telecommunication management; Performance Management (PM); Performance measurements Evolved Universal Terrestrial Radio Access Network (E-UTRAN)". +- [106] 3GPP TS 32.426: "Telecommunication management; Performance Management (PM); Performance measurements Evolved Packet Core (EPC) network". +- [107] 3GPP TS 32.432: "Telecommunication management; Performance measurement: File format definition". +- [108] 3GPP TS 32.435: "Telecommunication management; Performance measurement; eXtensible Markup Language (XML) file format definition". +- [109] 3GPP TS 32.436: "Telecommunication management; Performance measurement: Abstract Syntax Notation 1 (ASN.1) file format definition". +- [110] 3GPP TS 32.442: "Telecommunication management; Trace Management Integration Reference Point (IRP); Information Service (IS)". +- [111] 3GPP TS 32.446: "Telecommunication management; Trace Management Integration Reference Point (IRP); Solution Set (SS) definitions". + +- [112] 3GPP TS 32.451: "Telecommunication management; Key Performance Indicators (KPI) for Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Requirements". +- [113] 3GPP TS 32.452: "Telecommunication management; Performance Management (PM); Performance measurements Home Node B (HNB) Subsystem (HNS)". +- [114] 3GPP TS 32.453: "Telecommunication management; Performance Management (PM); Performance measurements Home enhanced Node B (HeNB) Subsystem (HeNS)". +- [115] 3GPP TS 32.454: "Telecommunication management; Key Performance Indicators (KPI) for the IP Multimedia Subsystem (IMS); Definitions". +- [116] 3GPP TS 32.455: "Telecommunication management; Key Performance Indicators (KPI) for the Evolved Packet Core (EPC); Definitions". +- [117] 3GPP TS 32.502: "Telecommunication management; Self-configuration of network elements Integration Reference Point (IRP); Information Service (IS)". +- [118] 3GPP TS 32.506: "Telecommunication management; Self-configuration of network elements Integration Reference Point (IRP); Solution Set (SS) definitions". +- [119] 3GPP TS 32.522: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [120] 3GPP TS 32.526: "Telecommunication management; Self-Organizing Networks (SON); Policy Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [121] 3GPP TS 32.531: "Telecommunication management; Software management (SwM); Concepts and Integration Reference Point (IRP) Requirements". +- [122] 3GPP TS 32.532: "Telecommunication management; Software management (SwM); Integration Reference Point (IRP); Information Service (IS)". +- [123] 3GPP TS 32.536: "Telecommunication management; Software management Integration Reference Point (IRP); Solution Set (SS) definitions". +- [124] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [125] 3GPP TS 32.611: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Requirements". +- [126] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Information Service (IS)". +- [127] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [128] 3GPP TS 32.621: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [129] 3GPP TS 32.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [130] 3GPP TS 32.626: "Telecommunication management; State management data definition Integration Reference Point (IRP); Solution Set (SS) definitions". +- [131] 3GPP TS 32.641: "Telecommunication management; Configuration Management (CM); UTRAN network resources Integration Reference Point (IRP); Requirements". +- [132] 3GPP TS 32.642: "Telecommunication management; Configuration Management (CM); UTRAN network resources Integration Reference Point (IRP); Network Resource Model (NRM)". +- [133] 3GPP TS 32.646: "Telecommunication management; Configuration Management (CM); UTRAN network resources Integration Reference Point (IRP); Solution Set (SS) definitions". + +- [134] 3GPP TS 32.661: "Telecommunication management; Configuration Management (CM); Kernel CM Requirements". +- [135] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)". +- [136] 3GPP TS 32.666: " Telecommunication management; Configuration Management (CM); Kernel CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [137] 3GPP TS 32.761: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [138] 3GPP TS 32.762: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [139] 3GPP TS 32.766: "Telecommunication management; Evolved Universal Terrestrial RadioAccess Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [140] 3GPP TS 32.402: "Telecommunication management; Performance Management (PM); Performance measurements – GSM". +- [141] 3GPP TS 32.181: "Telecommunication management; User Data Convergence (UDC); Framework for Model Handling and Management". +- [142] 3GPP TS 32.182: "Telecommunication management; User Data Convergence (UDC); Common baseline information model (CBIM)". +- [143] 3GPP TS 28.628: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) ". +- [144] 3GPP TS 28.629: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [145] 3GPP TS 28.631: "Telecommunication management; Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [146] 3GPP TS 28.632: "Telecommunication management; Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [147] 3GPP TS 28.633: "Telecommunication management; Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [148] 3GPP TS 28.651: "Telecommunication management; Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [149] 3GPP TS 28.652: "Telecommunication management; Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [150] 3GPP TS 28.653: "Telecommunication management; Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [151] 3GPP TS 28.654: "Telecommunication management; GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [152] 3GPP TS 28.655: "Telecommunication management; GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +- [153] 3GPP TS 28.656: "Telecommunication management; GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [154] 3GPP TS 28.657: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [155] 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)". +- [156] 3GPP TS 28.659: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [157] 3GPP TS 28.661: "Telecommunication management; Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [158] 3GPP TS 28.662: "Telecommunication management; Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [159] 3GPP TS 28.663: "Telecommunication management; Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [160] 3GPP TS 28.671: "Telecommunication management; Home Node B (HNB) Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [161] 3GPP TS 28.672: "Telecommunication management; Home Node B (HNB) Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [162] 3GPP TS 28.673: "Telecommunication management; Home Node B (HNB) Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [163] 3GPP TS 28.674: "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [164] 3GPP TS 28.675: "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [165] 3GPP TS 28.676: "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [166] 3GPP TS 28.701: "Telecommunication management; Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [167] 3GPP TS 28.702: "Telecommunication management; Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [168] 3GPP TS 28.703: "Telecommunication management; Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [169] 3GPP TS 28.704: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [170] 3GPP TS 28.705: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [171] 3GPP TS 28.706: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [172] 3GPP TS 28.707: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". + +- [173] 3GPP TS 28.708: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [174] 3GPP TS 28.709: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [175] 3GPP TS 28.731: "Telecommunication management; Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [176] 3GPP TS 28.732: "Telecommunication management; Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [177] 3GPP TS 28.733: "Telecommunication management; Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [178] 3GPP TS 28.734: "Telecommunication management; Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [179] 3GPP TS 28.735: "Telecommunication management; Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [180] 3GPP TS 28.736: "Telecommunication management; Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [181] 3GPP TS 28.751: "Telecommunication management; Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [182] 3GPP TS 28.752: "Telecommunication management; Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [183] 3GPP TS 28.753: "Telecommunication management; Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [184] 3GPP TS 28.611: "Telecommunication management; Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [185] 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)". +- [186] 3GPP TS 28.616: "Telecommunication management; Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [187] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [188] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [189] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions". +- [190] 3GPP TS 28.510: "Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Requirements". +- [191] 3GPP TS 28.511: "Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Procedures". +- [192] 3GPP TS 28.512: "Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 2". +- [193] 3GPP TS 28.513: "Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 3". + +- [194] 3GPP TS 28.515: "Telecommunication management; Fault Management (FM) for mobile networks that include virtualized network functions; Requirements". +- [195] 3GPP TS 28.516: "Telecommunication management; Fault Management (FM) for mobile networks that include virtualized network functions; Procedures". +- [196] 3GPP TS 28.517: "Telecommunication management; Fault Management (FM) for mobile networks that include virtualized network functions; Stage 2". +- [197] 3GPP TS 28.518: "Telecommunication management; Fault Management (FM) for mobile networks that include virtualized network functions; Stage 3". +- [198] 3GPP TS 28.520: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Requirements". +- [199] 3GPP TS 28.521: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Procedures". +- [200] 3GPP TS 28.522: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 2". +- [201] 3GPP TS 28.523: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 3". +- [202] 3GPP TS 28.525: "Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Requirements". +- [203] 3GPP TS 28.526: "Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Procedures". +- [204] 3GPP TS 28.527: "Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 2". +- [205] 3GPP TS 28.528: "Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 3". +- [206] 3GPP TS 32.581: "Telecommunication management; Home Node B (HNB) Operations, Administration, Maintenance and Provisioning (OAM&P); Concepts and requirements for Type 1 interface HNB to HNB Management System (HMS)". +- [207] 3GPP TS 32.582: "Telecommunication management; Home Node B (HNB) Operations, Administration, Maintenance and Provisioning (OAM&P); Information model for Type 1 interface HNB to HNB Management System (HMS)". + +# --- 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.150 [2], TS 32.101 [3] and the following apply + +**Data Definition IRP:** 3GPP publishes IRP specifications relating to commonly used data definitions that can be imported for use by Interface IRP and/or NRM IRP. This term represents all such specifications. An example of a Data Definition IRP is the State Management IRP (28.624 [4], 28.625 [5], 28.626 [6], etc). + +**Integration Reference Point (IRP):** An architectural concept that is described by a set of specifications for definition of a certain aspect of a management interface, comprising a **Requirements** specification, an **Information Service** specification, and one or more **Solution Set** specifications. + +**Interface IRP:** 3GPP publishes a number of IRP specifications each of which is related to a set of operations and notifications for a specific telecom management domain such as alarm management, configuration management, etc. Interface IRPs also contain definitions of Support IOCs. This term represents all such specifications. An example of an Interface IRP is the Basic CM IRP (the set of TSs 32.601 [7], 32.602 [8], 32.603 [9], etc.). + +**IRP Agent:** Encapsulates a well-defined subset of network (element) functions. It interacts with IRPManagers using one or more IRPs. From the IRPManager's perspective, the IRP Agent behaviour is only visible via the IRP(s). + +**Information Service (IS):** an IRP Information Service describes the information related to the entities (either network resources or support objects) to be managed and the way that the information may be managed for a certain functional area (e.g. the Alarm IRP Information Service in the fault management area). Information Services are defined for all IRPs. + +**IRP Manager:** Models a user of IRP Agent(s) and it interacts directly with the IRP Agent(s) using IRP(s). Since the IRP Manager represents an IRP Agent user, it gives a clear picture of what the IRP Agent is supposed to do. From the IRP Agent perspective, the IRP Manager behaviour is only visible via the IRP. + +**Network Resource Model (NRM):** An Information Service describing Information Object Classes representing the manageable aspects of network resources, e.g. an RNC or NodeB. + +**NRM IRP:** 3GPP publishes a number of IRP specifications each of which is related to a particular NRM (Network Resource Model) as defined in 3GPP TS 32.101 [3]. NRM IRPs do not define any operations or notifications. This term represents all such specifications. Note: In some NRM IRP titles, for historic reasons, they are named "...network resources IRP"). An example of an NRM IRP is the Generic NRM IRP (28.621 [10], 28.622 [11], 28.623 [12], etc.). + +**Solution Set (SS):** contains a mapping of the IRP Information Service (IS) defined entities (that are technology-agnostic) to technology specific termed entities. It does not contain specification of the entities' semantics. The semantics can be found in the corresponding IS. It is noted that one IS can be mapped to one or several SSs.. + +## 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]. + +| | | +|------|-------------------------------------| +| AN | Access Network | +| CN | Core Network | +| FMC | Fixed Mobile Convergence | +| FNIM | Federated Network Information Model | +| IF | Interface | +| IRP | Integration Reference Point | +| IS | Information Service | +| NFV | Network Function Virtualization | +| NRM | Network Resource Model | +| PM | Performance Management | +| SS | Solution Set | +| UIM | Umbrella Information Model | +| WLAN | Wireless Local Area Network | + +# --- 4 IRP Framework + +## 4.1 Introduction + +For the purpose of management interface development 3GPP has developed an interface concept known as Integration Reference Point (IRP) to promote the wider adoption of standardized management interfaces in telecommunication networks. The IRP concept and associated methodology employs model-driven development, protocol and technology neutral modelling methods as well as protocol specific solution sets to achieve its goals. + +IRP Framework and Methodology related 3GPP specifications: + +- 32.150 [2]: Integration Reference Point (IRP) Concept and definitions +- 32.153 [15]: IRP technology specific templates, rules and guidelines +- 32.154 [16]: Backward and Forward Compatibility Concept and definitions +- 32.155 [17]: Requirements template +- 32.156 [18]: Fixed Mobile Convergence (FMC) Model repertoire +- 32.157 [19]: IRP Information Service (IS) template + +## 4.2 IRP Framework Highlights + +### 4.2.1 IRP Concept + +IRP specifications are specified using a 3-level approach: Requirements, IS-level and SS-level. + +![Diagram of the IRP 3-level specifications approach showing Requirements, Information Service, and Solution Set Definitions levels, with their respective stability and change characteristics.](8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg) + +The diagram illustrates the 3-level IRP specifications approach. It consists of three main levels connected vertically by lines. To the right of each level is an oval containing a characteristic of that level. + +- Requirements / Use Cases** (Top level): + - Associated oval: **Relatively stable over long period of time** +- Information Service** (Middle level): + - This level is divided into three sub-sections: + - Interface IRPs**: + - Notification IRP + - Alarm IRP + - Bulk CM IRP + - Kernel CM IRP + - Basic CM IRP + - PM IRP + - Etc. + - Network Resource Model (NRM) IRPs**: + - Generic NRM IRP + - UTRAN NRM IRP + - E-UTRAN NRM IRP + - IMS NRM IRP + - EPC NRM IRP + - Etc. + - Data Definition IRPs**: + - State Management IRP + - Associated oval: **Change only with respect to functional additions and corrections** +- Solution Set Definitions (CORBA, XML, SOAP)** (Bottom level): + - Below this is another box: **Solution Set Definitions (other/future)** + - Associated oval: **Change with new/better technologies** + +Diagram of the IRP 3-level specifications approach showing Requirements, Information Service, and Solution Set Definitions levels, with their respective stability and change characteristics. + +Figure 4.2-1: The IRP 3-level specifications approach combined with the three IRP categories + +#### **Requirements-level:** + +The "Requirements-level" intends to provide conceptual and use cases definitions for a specific management interface aspect as well as defining subsequent requirements for this IRP. + +#### **IS-level:** + +The "IS-level" provides the technology independent specification of an IRP. + +#### **SS-level:** + +The "SS-level" finally provides the mapping of IS definitions into one or more technology-specific Solution Sets. This concept provides support for multiple interface technologies as applicable on a vendor and/or network type basis and also enables accommodation of future interface technologies - without the need to redefine requirements and IS-level definitions. + +### 4.2.2 Relationships between IRPs + +There are three categories of IRP specifications: + +- Interface IRPs +- NRM IRPs +- Data Definition IRPs + +Each category is partitioned into Requirements, IS-level and SS-level specifications. + +Relationships between various kinds of IRPs: + +- Some Interface IRPs and NRM IRPs are used together. Such Interface IRPs operate on entities modelled by NRM IRPs. For example, operations defined in Basic CM IRP are used together with E-UTRAN NRM IRP to support E-UTRAN configuration management function. +- Interface IRPs are network/radio technology independent and can operate on entities modelled by NRM IRPs of different network technologies. For example, operations defined in Basic CM IRP are used together with E-UTRAN NRM IRP or UTRAN NRM IRP to support E-UTRAN or UTRAN configuration management functions. +- Interface IRPs are Converged Management ready (e.g. support management of fixed and/or mobile) and can operate on modelled mobile and/or fixed network entities. +- A Data Definition IRP provides common data definitions, referenced by specifications of Interface IRPs and NRM IRPs. + +![Diagram illustrating the relationship between Interface IRPs and Network Resource Model (NRM) IRPs in a network management architecture.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +The diagram shows a network management architecture. At the top is a **Network Manager** connected via an **Itf-N** interface to two **DM/EM** (Domain Manager/Element Manager) blocks. These DM/EM blocks are connected to a **Core/IMS Network** and a **Radio Access Network**, which in turn are connected to **User Equipment**. Two callouts explain the roles of different IRPs: + + +- Interface IRPs**: Defining HOW information is shared (operations & notifications). An arrow points from this callout to the **Itf-N** interface. +- Network Resource Model (NRM) IRPs**: Defining WHAT can be managed (object models). Arrows point from this callout to both the **Core/IMS Network** and the **Radio Access Network**. + +Diagram illustrating the relationship between Interface IRPs and Network Resource Model (NRM) IRPs in a network management architecture. + +Figure 4.2-2: Relationship Interface IRP vs NRM IRP + +### 4.2.3 IRP Development Principles + +**NRM IRP Extendibility** - Enabling Technology, Organizational & Vendor-specific NRM extensions via + +- Rule-based NRM Extensions (e.g. Sub-classing) +- vsDataContainer + +**Interface IRP Flexibility** - Enabling: wide applicability, phased introduction capabilities & broad industry adoption (not just for wireless) via + +- Flexible use of qualifiers "mandatory", "optional", "conditional" for operation, notifications and/or parameters +- NRM/Technology-neutrality & avoiding competing procedures + +### 4.2.4 IRP Specification Structure + +32-series IRPs follow a uniform specification structure: + +- xx1: xyz IRP Requirements +- xx2: xyz IRP IS +- xx3: xyz IRP CORBA SS (merged into xx6 after R9) +- xx4: xyz IRP CMIP SS (retired after R6) +- xx5: xyz IRP XML Definitions (applicable for NRM's & notification emitting IRPs - merged into xx6 after R9) + +- xx6: xyz IRP SS (since Rel-10, containing all technology specific Solution Set definitions) +*xx7: xyz IRP SOAP SS (merged into xx6 after R9)* + +28-series IRPs (supporting FMC) consisting of 3-specification sets, structured as follows: + +- 28.3xx: Interface IRP specifications. +- 28.611-28.616 EPC and non-3GPP access interworking system NRM IRP +- 28.620-28.649: Common/Generic NRM IRPs. +- 28.650-28.699: Access Network related NRM IRPs. +- 28.700-28.729: CN-related NRM IRPs. +- 28.730-28.749: Transport-related NRM IRPs. +- 28.750-28.769: Service-related NRM IRPs. +- 28.770-28.799: *reserved for future topic NRM IRPs.* + +### 4.2.5 Void + +## 4.3 IRP related High-level Requirements & Architecture Specifications + +The IRP Framework has been developed in response to management requirements documented in the following specifications: + +- 32.101 [3]: Principles and high level requirements +- 32.102 [20]: Architecture +- 32.107 [21]: Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) +- 32.111-1 [22]: 3G fault management requirements +- 32.140 [23], SuM requirements +- 32.141 [24]: SuM architecture +- 32.300 [25]: Name convention for Managed Objects +- 32.401 [26]: PM Concept and requirements +- 32.500 [27]: SON Concepts and requirements +- 32.511 [28]: ANR management Concepts and requirements +- 32.521 [29]: Self-optimization Concepts and requirements +- 32.541 [30]: Self-healing Concepts and requirements +- 32.551 [31]: Energy Saving Management (ESM) Concepts and requirements +- 32.600 [32]: CM Concept and high-level requirements + +## 4.4 Converged Management and IRPs + +As outlined in previous sections, 3GPP Interface IRPs are network-technology-independent, and therefore can be utilized for the management of various network technologies. + +To further ease converged management (the common management of multiple network technologies) and to address the need for OPEX reduction, 3GPP together with other industry organizations (i.e. NGMN and TM Forum) developed jointly the following specifications: + +- Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) (published in 3GPP as TS 32.107 [21]) + - Defining conceptually the federated network information model and the relationships between participating models (see also section 5.5 of TS 32.101 [3]). +- FMC FNIM Umbrella Information Model (UIM) (published in 3GPP as TS 28.620 [34]) + - Providing abstract definitions of information objects applicable across Domain/Technology-specific Concrete Models. +- Fixed Mobile Convergence (FMC) Model repertoire (published in 3GPP as TS 32.156 [18]) + - Defining meta definitions for models supporting converged management. +- Fixed Mobile Convergence (FMC) 3GPP / TM Forum Concrete Model Relationships and Use Cases + - Proposing the specific structure of model and realisation of that structure across 3GPP and TM Forum by taking advantage of current TM Forum transport-oriented model work (SID, MTNM/MTOSI) as well as current 3GPP SA5 mobile-oriented model work (NRM IRPs etc.). + +Based on above, 3GPP has applied definitions provided by these specifications by creating the 28-series variants of the 3GPP NRM IRPs to support converged management. + +# 5 Interface IRPs + +## 5.1 Interface IRP Overview + +![Diagram showing the classification of 3GPP Interface IRPs into various categories.](d9c0a780cd22626253dab4aa41699e2f_img.jpg) + +The diagram illustrates the classification of 3GPP Interface IRPs into several categories, each presented in a separate box: + +- Common Interface IRPs** + - Notification IRP (32.30x) + - Generic IRP (32.31x) +- Other Interface IRPs** + - Partial Suspension of Itf-N IRP (32.38x) + - Delta synchronization IRP (32.39x) +- CM related IRPs** + - Basic CM IRP (32.60x) + - Bulk CM IRP (32.61x) + - Kernel CM IRP (32.66x) +- SON related Interface IRPs** + - Self-Configuration IRP (32.50x) + - Software Management IRP (32.53x) +- FM related IRPs** + - Alarm IRP (32.111-x) + - AAM IRP (32.12x) + - Test Mgmt IRP (32.32x) +- PM related IRPs** + - PM IRP (32.41x) + - PM file format/collection (32.43x) + - Trace Mgmt (32.42X, 32.44x) +- Supporting Interface IRPs** + - Notification Log IRP (32.33x) + - File Transfer IRP (32.34x) + - Communication Surveillance IRP (32.35x) + - Entry Point IRP (32.36x) + +Diagram showing the classification of 3GPP Interface IRPs into various categories. + +Figure 5.1-1: 3GPP Interface IRPs + +## 5.2 Generic/Common Interface IRPs + +Notification IRP – 32.300 [25], 32.301 [68], 32.302 [69], 32.306 [70] + +The purpose of the Notification IRP is to define an interface through which an IRPManager can subscribe to an IRPAgent for receiving notifications, manage these subscriptions, and optionally set filters. + +Generic IRP – 32.311 [71], 32.312 [72], 32.316 [73] + +This IRP defines common services supported by all IRPs such as AlarmIRP. With this common service supported by all IRPs, an IRPManager can retrieve the profile of operations and notifications supported by a given IRP name-contained by an IRPAgent. An IRPManager can also retrieve the IRPVersions supported by a given IRP. + +## 5.3 FM related interface IRPs + +### **Alarm IRP – 32.111-1 [22], 32.111-2 [63], 32.111-6 [64]** + +The Alarm (IRP) addresses the alarm surveillance aspects of Fault Management (FM), applied to Itf-N. It defines alarm semantics & syntax as well as alarm management related operations and notifications. + +### **Advanced Alarm Management IRP – 32.121 [65], 32.122 [66], 32.126 [67]** + +The purpose of Advanced Alarm Management (AAM) IRP is to define an interface through which an IRPManager can categorize alarm notifications. It defines, for the purpose of categorizing alarm notifications, the information observable and controlled by management system's client and it also specifies the semantics of the interactions used to carry this information. + +### **Test management IRP – 32.321 [74], 32.322 [75], 32.326 [76]** + +The purpose of the Test management IRP is to define an interface through which an IRPManager can manage and monitor tests in NE's, as well as methods to receive test results. + +## 5.4 CM related interface IRPs + +### **Basic CM IRP – 32.600 [32], 32.601 [7], 32.602 [8], 32.603 [9], 32.606 [124]** + +Using this IRP, an IRPAgent can communicate basic Configuration Management related information to one or several IRPManagers. The function of this Basic CM IRP Information Service is to define an interface for the retrieval and modification of Configuration Management Information. + +### **Bulk CM IRP – 32.611 [125], 32.612 [126], 32.616 [127]** + +Using the Bulk CM IRP an IRPAgent can communicate CM related information to one or several IRPManagers using bulk data transfer methods. + +- BulkCM SimpleUpload, enabling upload of resource information by the IRPManager without explicit session control +- BulkCM Controlled Upload, enabling a session controlled upload of resource information by the IRPManager +- BulkCM Controlled Upload & Provisioning, enabling a session controlled upload and provisioning of resource information by the IRPManager + +### **Kernel CM IRP – 32.661 [134], 32.662 [135], 32.666 [136]** + +The function of this Kernel CM IRP Information Service is to define an interface that provides essential CM notification services. While it is not expected that the Kernel CM IRP alone will provide adequate CM capabilities, the Kernel CM IRP is expected to provide the common supporting CM notifications required for other CM IRPs such as the Basic CM IRP or the Bulk CM IRP, each of which require the Kernel CM IRP. + +## 5.5 PM file format/collection & Trace related Interface IRPs + +### **Performance Management IRP – 32.410 [100], 32.411 [101], 32.412 [102], 32.416 [103]** + +The Performance Management IRP defines an interface through which an IRPManager can manage measurement jobs as well threshold values. + +### **Performance Measurement collection – 32.432 [107], 32.435 [108], 32.406 [109]** + +The Performance Measurement collection specifications describe the general semantics of performance measurement result and collection. They define the report file format, report file conventions and the file transfer procedure. + +### **Trace Management IRP – 32.441 [38], 32.442 [110], 32.446 [111]** + +The Trace Management IRP is defines an interface through which an IRPManager can activate and manage equipment and subscriber trace jobs. + +## 5.6 Special-purpose related Interface IRPs + +### **Notification Log IRP – 32.331 [77], 32.332 [78], 32.336 [79]** + +The purpose of the Notification Log IRP is to define an interface through which an IRPManager can manage a Notification Log, as well as methods for retrieval of logged notifications. + +### **File Transfer IRP – 32.341 [80], 32.342 [81], 32.346 [82]** + +The purpose of the File Transfer IRP is to define a generic tools set supporting the management of file transfers between IRPManager and IRPAgent. Currently the following management data types are supported by this IRP: + +- performance data files +- configuration & inventory files +- test result files +- call trace files +- notification log files +- charging files + +### **Communication Surveillance IRP – 32.351 [83], 32.352 [84], 32.356 [85]** + +The purpose of the Communication Surveillance IRP is to provide an IRPManager with the capability to monitor the health of the communications link towards an IRPAgent. + +### **Entry Point IRP – 32.361 [86], 32.362 [87], 32.366 [88]** + +The purpose of the Entry Point IRP is to provide an IRPManager with discovery and entry point capabilities towards an IRPAgent and its supported IRPs. + +### **Partial Suspension of Itf-N IRP – 32.381 [89], 32.382 [90], 32.386 [91]** + +The purpose of Partial Suspension of Itf-N IRP is to define an interface through which an IRPManager can suspend the forwarding of notifications via Itf-N which were generated in parts of the managed systems. + +### **Delta synchronization IRP – 32.391 [92], 32.392 [93], 32.396 [94]** + +The purpose of Delta Synchronization IRP is to define an interface through which an IRPManager can request only those data that have changed (i.e. changed, were created or deleted) from a synchronization point onwards. + +## 5.7 SON related Interface IRPs + +### **Self-Configuration IRP – 32.500 [27], 32.501 [36], 32.502 [117], 32.506 [118]** + +The Self-Configuration provides methods to allow automatic configuration of eNBs, which are brought newly into a network. + +### **Software Management IRP – 32.531 [121], 32.532 [122], 32.536 [123]** + +The Software Management IRP provides an IRPManager with capabilities to automate software management via Itf-N. + +# 6 NRM IRPs + +## 6.1 NRM IRP Overview + +![Diagram showing the hierarchy of 3GPP NRM IRPs. The diagram is organized into two columns. The left column lists: FMC model (Umbrella Information Model (28.620)), Common NRM IRP (Generic NRM IRP (28.621/2/3)), Self-Organizing Networks NRM IRP (SON Policy NRM IRP (28.627/8/9)), 3GPP Access Network NRM IRPs (Generic RAN NRM IRP (28.661/2/3), GERAN NRM IRP (28.654/5/6), UTRAN NRM IRP (28.651/2/3), E-UTRAN NRM IRP (28.657/8/9)), Wireless Local Area Network NRM IRP (WLAN NRM IRP (28.681/2/3)), and Supporting NRM IRPs (Inventory Management NRM IRP (28.631/2/3), Transport Network NRM IRP (28.731/2/3), Signalling Transport Network (STN) interface NRM IRP (28.734/5/6)). The right column lists: Service Management NRM IRPs (SuM NRM IRP (28.751/2/3)), 3GPP Core Network NRM IRPs (CN NRM IRP (28.701/2/3), IMS NRM IRP (28.704/5/6), EPC NRM IRP (28.707/8/9)), 3GPP H(e)NS NRM IRPs (HNS NRM IRP (28.671/2/3), HeNS NRM IRP (28.674/5/6)), and Non-3GPP access interworking NRM IRPs (EPC and non-3GPP access interworking system NRM IRP (28.611/2/6)).](4cde160bcc69b7b6c81b648dd0e4252e_img.jpg) + +**FMC model** + +- Umbrella Information Model (28.620) + +**Service Management NRM IRPs** + +- SuM NRM IRP (28.751/2/3) + +**Common NRM IRP** + +- Generic NRM IRP (28.621/2/3) + +**3GPP Core Network NRM IRPs** + +- CN NRM IRP (28.701/2/3) +- IMS NRM IRP (28.704/5/6) +- EPC NRM IRP (28.707/8/9) + +**Self-Organizing Networks NRM IRP** + +- SON Policy NRM IRP (28.627/8/9) + +**3GPP H(e)NS NRM IRPs** + +- HNS NRM IRP (28.671/2/3) +- HeNS NRM IRP (28.674/5/6) + +**3GPP Access Network NRM IRPs** + +- Generic RAN NRM IRP (28.661/2/3) +- GERAN NRM IRP (28.654/5/6) +- UTRAN NRM IRP (28.651/2/3) +- E-UTRAN NRM IRP (28.657/8/9) + +**Non-3GPP access interworking NRM IRPs** + +- EPC and non-3GPP access interworking system NRM IRP (28.611/2/6) + +**Wireless Local Area Network NRM IRP** + +- WLAN NRM IRP (28.681/2/3) + +**Supporting NRM IRPs** + +- Inventory Management NRM IRP (28.631/2/3) +- Transport Network NRM IRP (28.731/2/3) +- Signalling Transport Network (STN) interface NRM IRP (28.734/5/6) + +Diagram showing the hierarchy of 3GPP NRM IRPs. The diagram is organized into two columns. The left column lists: FMC model (Umbrella Information Model (28.620)), Common NRM IRP (Generic NRM IRP (28.621/2/3)), Self-Organizing Networks NRM IRP (SON Policy NRM IRP (28.627/8/9)), 3GPP Access Network NRM IRPs (Generic RAN NRM IRP (28.661/2/3), GERAN NRM IRP (28.654/5/6), UTRAN NRM IRP (28.651/2/3), E-UTRAN NRM IRP (28.657/8/9)), Wireless Local Area Network NRM IRP (WLAN NRM IRP (28.681/2/3)), and Supporting NRM IRPs (Inventory Management NRM IRP (28.631/2/3), Transport Network NRM IRP (28.731/2/3), Signalling Transport Network (STN) interface NRM IRP (28.734/5/6)). The right column lists: Service Management NRM IRPs (SuM NRM IRP (28.751/2/3)), 3GPP Core Network NRM IRPs (CN NRM IRP (28.701/2/3), IMS NRM IRP (28.704/5/6), EPC NRM IRP (28.707/8/9)), 3GPP H(e)NS NRM IRPs (HNS NRM IRP (28.671/2/3), HeNS NRM IRP (28.674/5/6)), and Non-3GPP access interworking NRM IRPs (EPC and non-3GPP access interworking system NRM IRP (28.611/2/6)). + +Figure 6.1-1: 3GPP NRM IRPs + +## 6.2 FMC Models and Common NRM IRPs + +### FMC FNIM Umbrella Information Model (UIM) – 28.620 [34] + +The Umbrella Information Model (UIM) provides abstract definitions of information objects applicable across Domain/Technology-specific Concrete Models to enable end-to-end consistency of such definitions. These definitions are used by the Generic NRM IRP (28.621 [10], 28.622 [11], 28.623 [12]) to enable 3GPP NRM IRPs to be part of the industry-wide Federated Network Information Model (FNIM). + +### Generic NRM IRP – 28.621 [10], 28.622 [11], 28.623 [12] + +The Generic NRM IRP provides the generic network resources information that can be communicated between an IRP Agent and one or several IRP Managers for network management purposes. To enable converged management, the Generic NRM IRP as defined in 28.621 [10], 28.622 [11], 28.623 [12] uses the common definitions specified in the FMC FNIM Umbrella Information Model (UIM). + +## 6.3 Access Network (AN) related NRM IRPs + +### **UTRAN NRM IRP – 28.651 [148], 28.652 [149], 28.653 [150]** + +The UTRAN NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning UTRAN specific network resource, by reusing relevant parts of the Generic NRM IRP. + +### **GERAN NRM IRP – 28.654 [151], 28.655 [152], 28.656 [153]** + +The GERAN NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning GERAN specific network resource, by reusing relevant parts of the Generic NRM IRP. + +### **E-UTRAN NRM IRP – 28.657 [154], 28.658 [155], 28.659 [156]** + +The E-UTRAN NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning E-UTRAN specific network resource, by reusing relevant parts of the Generic NRM IRP. + +### **Generic RAN NRM IRP – 28.661 [157], 28.662 [158], 28.663 [159]** + +The Generic RAN NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning common RAN network resource (applicable to GERAN, UTRAN and E\_UTRAN), by reusing relevant parts of the Generic NRM IRP. + +## 6.4 Core Network (CN)/IMS related NRM IRPs + +### **CN NRM IRP – 28.701 [166], 28.702 [167], 28.703 [168]** + +The CN NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning core network specific resource, by reusing relevant parts of the Generic NRM IRP in. + +### **IMS NRM IRP – 28.704 [169], 28.705 [170], 28.706 [171]** + +The IMS NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning IP Multimedia Subsystem specific network resource, by reusing relevant parts of the Generic NRM IRP. + +### **Evolved Packet Core (EPC) NRM IRP – 28.707 [172], 28.708 [173], 28.709 [174]** + +The EPC NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Evolved Packet Core specific network resource, by reusing relevant parts of the Generic NRM IRP. + +## 6.5 H(e)NB related NRM IRPs + +### **HNS NRM IRP – 28.671 [160], 28.672 [161], 28.673 [162]** + +The HNS NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Home NodeB Subsystem specific network resource, by reusing relevant parts of the Generic NRM IRP. + +### **HeNS NRM IRP – 28.674 [163], 28.675 [164], 28.676 [165]** + +The HeNS NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Home enhanced NodeB Subsystem specific network resource, by reusing relevant parts of the Generic NRM IRP. + +## 6.6 Service management related NRM IRPs and UDC specifications + +### **SuM NRM IRP – 28.751 [181], 28.752 [182], 28.753 [183]** + +Subscription Management is a feature that permits Service Providers, Value Added Service Providers and Mobile Operators to provision services for a specific subscriber. The SuM NRM IRP defines the Subscription Management specific network resource information between an IRP Agent and one or several IRP Managers. + +### **UDC – 32.181 [141], 32.182 [142]** + +User Data Convergence (UDC) presents a layered architecture where user data is accessible at a logically unique repository called User Data Repository (UDR). The UDC CBIM defines a Common Baseline Information Model for UDC, which denotes an abstract, formal representation of entity types that are common to many applications using the UDR. + +## 6.7 Special-purpose related NRM IRPs + +### **Inventory Management NRM IRP – 28.631 [145], 28.632 [146], 28.633 [147]** + +Inventory Management (IM) provides the operator with the ability to assure correct and effective operation of the telecom network as it evolves. IM actions have the objective to monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs). The Inventory Management NRM IRP defines the inventory specific network resource information between an IRP Agent and one or several IRP Managers. + +### **SON Policy NRM IRP – 28.627[35], 28.628 [143], 28.629 [144]** + +The SON Policy NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Self-Organizing Networks Policies. Currently the following SON use cases are supported by this NRM IRP: + +- SON Self-Optimization Management (requirements determined by TS 32.521 [29], 28.627 [35]) +- SON Self-Healing Management (requirements determined by TS 32.541 [30]) +- Energy Saving Management (requirements determined by TS 32.551 [31]) + +### **Transport Network NRM IRP – 28.731 [175], 28.732 [176], 28.733 [177]** + +The Transport Network NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Transport resources, by reusing relevant parts of the Generic NRM IRP. + +### **Signalling Transport NW IF NRM IRP – 28.734 [178], 28.735 [179], 28.736 [180]** + +The Signalling Transport NW IF NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Signalling Transport resources, by reusing relevant parts of the Generic NRM IRP. + +## 6.8 EPC interworking with non-3GPP access NRM IRPs + +### **Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) IRP – 28.611 [184], 28.612 [185], 28.616 [186]** + +This IRP describes the Network Resource Model (NRM) for the EPC and WLAN interworking system according to the structure defined in 3GPP TS 23.402 [8] (e.g. ePDG, 3GPP AAA, etc.). + +# 7 Measurement & Trace Definitions + +## 7.1 Performance Measurements + +### 7.1.1 Overview and relationships to IRP Framework + +![Diagram showing PM-related Specifications categorized into Requirements and templates, Core measurement specifications, Radio measurement specifications, Other measurement specifications, KPI specifications, and PM file format.](98e54d5540b2efe3e24af3cf936bc4ea_img.jpg) + +``` +graph TD; A[Requirements and templates] --> B[Core measurement specifications]; A --> C[Radio measurement specifications]; B --> D[Other measurement specifications]; C --> E[KPI specifications]; E --> F[PM file format 32.43x]; +``` + +**Requirements and templates** + +- Concepts and requirements (32.401) +- Definitions and templates (32.404) + +**Core measurement specifications** + +- CS core (32.407) +- PS core (32.406) +- IMS (32.409) +- EPC (32.426) +- Services (32.408) + +**Radio measurement specifications** + +- GSM (52.402) +- UTRAN (32.405) +- E-UTRAN (32.425) +- HNB (32.452) +- HeNB (32.453) + +**Other measurement specifications** + +- EPC and non-3GPP access interworking system (28.402) +- WLAN (28.403) + +**KPI specifications** + +- UMTS and GSM (32.410) +- E-UTRAN (32.450/451) +- IMS (32.454) +- EPC (32.455) + +**PM file format (32.43x)** + +Diagram showing PM-related Specifications categorized into Requirements and templates, Core measurement specifications, Radio measurement specifications, Other measurement specifications, KPI specifications, and PM file format. + +Figure 7.1.1-1: PM-related Specifications + +### 7.1.2 Performance Measurement Specifications + +#### **PS core Performance Measurements – 32.406 [96]** + +The purpose of this specification is to define performance measurements specific to Core Network Packet Switched Domain in a UMTS network or combined UMTS/GSM network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **CS core Performance Measurements – 32.407 [97]** + +The purpose of this specification is to define performance measurements specific to Core Network Circuit Switched Domain in a UMTS network or combined UMTS/GSM network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **Services Performance Measurements – 32.408 [98]** + +The purpose of this specification is to define performance measurements specific to teleservices(categorized by Multimedia Messaging Service, Short Message Service, Multimedia Calls, Voice Call and Intelligent Services) in a UMTS network or combined UMTS/GSM network, . The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **IMS Performance Measurements – 32.409 [99]** + +The purpose of this specification is to define performance measurements specific to an IMS (IP Multimedia Subsystem) network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **EPC Performance Measurements – 32.426 [106]** + +The purpose of this specification is to define performance measurements specific to an EPC network or combined EPC/UMTS/GSM network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **GSM Performance Measurements – 52.402 [140]** + +The purpose of this specification is to define performance measurements specific to a GSM system. The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **UTRAN Performance Measurements – 32.405 [95]** + +The purpose of this specification is to define performance measurements specific to a UTRAN in UMTS network or combined UMTS/GSM network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **E-UTRAN Performance Measurements – 32.425 [105]** + +The purpose of this specification is to define performance measurements specific to an E-UTRAN network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **HNB Performance Measurements – 32.452 [113]** + +The purpose of this specification is to define performance measurements specific to Home NodeB Subsystem(consists of HNB and HNB-GW). The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **HeNB Performance Measurements – 32.453 [114]** + +The purpose of this specification is to define performance measurements specific to Home enhanced NodeB Subsystem(consists of HeNB and optionally HeNB-GW). The standardized measurements result in comparability of measurement data produced in a multi-vendor network. + +#### **UMTS & GSM KPIs – 32.410 [100]** + +The purpose of this specification is to define Key Performance Indicators (KPIs) for GSM and UMTS. KPI definitions include high level KPIs that are a) common across GSM and UMTS networks; and b) **specific** to network techniques such as GSM and UMTS networks. + +#### **E-UTRAN KPIs – 32.451 [112]** + +This specification defines requirements (business level requirements, specification level requirements and use case descriptions) related to KPIs for E-UTRAN. + +#### **IMS KPIs – 32.454 [115]** + +This specification defines KPIs for the IP Multimedia Subsystem (IMS). + +#### **EPC KPIs – 32.455 [116]** + +This specification defines KPIs for the Evolved Packet Core (EPC).network. + +#### **PM File Format – 32.432 [107], 32.435 [108], 32.406 [109]** + +This set of specifications describe the general semantics of performance measurement result and collection. It defines the report file format, report file conventions, and the file transfer procedure. **Performance measurements for Evolved Packet Core (EPC) and non-3GPP access interworking system – 28.402 [61]** + +This specification describes the measurements for EPC and non-3GPP access network interworking and is valid for all measurement types provided by an implementation of EPC and non-3GPP access Interworking System. 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. + +#### **Performance measurements for Wireless Local Area Network (WLAN) – 28.403 [62]** + +This specification describes the measurements for WLAN and is valid for all measurement types provided by an implementation of a WLAN. 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. + +## 7.2 Trace Specifications + +### 7.2.1 Overview and relationships to IRP Framework + +![Diagram showing two boxes of trace-related specifications. The top box lists 'Trace specifications' with three items: Concepts and requirements (32.421), Trace control and configuration management (32.422), and Trace data definition (32.423). The bottom box lists 'Trace IRP specifications' with three items: Trace IRP Requirements (32.441), Trace IRP Information service (32.442), and Trace IRP Solution sets (32.446).](a4b963a07cc368283154762c4b156fe7_img.jpg) + +``` +graph TD; A["Trace specifications +• Concepts and requirements (32.421) +• Trace control and configuration management (32.422) +• Trace data definition (32.423)"] --- B["Trace IRP specifications +• Trace IRP Requirements (32.441) +• Trace IRP Information service (32.442) +• Trace IRP Solution sets (32.446)"] +``` + +Diagram showing two boxes of trace-related specifications. The top box lists 'Trace specifications' with three items: Concepts and requirements (32.421), Trace control and configuration management (32.422), and Trace data definition (32.423). The bottom box lists 'Trace IRP specifications' with three items: Trace IRP Requirements (32.441), Trace IRP Information service (32.442), and Trace IRP Solution sets (32.446). + +Figure 7.2.1-2: Trace-related Specifications + +### 7.2.2 Trace Specifications + +#### Trace Concepts and Requirements – 32.421 [37] + +The present document describes the requirements for the management of Trace and the reporting of Trace data (including FDD mode and TDD mode) across UMTS networks or EPS networks as it refers to subscriber tracing (tracing of IMSI or Public User Identity) and equipment tracing (tracing of IMEI or IMEISV). Trace also includes the ability to trace all active calls in a cell or multiple cells (Cell Traffic Trace). The present document also includes the description of Service Level Tracing (tracing of a specific service). It defines the administration of Trace Session activation/deactivation by the Element Manager (EM), the network or User Equipment (UE) itself via signalling, the generation of Trace results in the Network Elements (NEs) and UE and the transfer of these results to one or more Operations Systems, i.e. EM(s) and/or Network Manager(s) (NM(s)). + +#### Trace Control & Configuration – 32.422 [57] + +This specification describes the mechanisms used for the control and configuration of the Trace functionality at the EMs, NEs and UEs. It covers the triggering events for starting/stopping of subscriber/UE activity traced over 3GPP standardized signalling interfaces, the types of trace mechanisms, configuration of a trace, level of detail available in the trace data, the generation of Trace results in the Network Elements (NEs) and User Equipment (UE) and the transfer of these results to one or more EM(s) and/or Network Manager(s) (NM(s)). + +#### Trace Data Definitions – 32.423 [104] + +This specification describes Trace data definition and management. It covers the trace records content, their format and transfer. + +#### Trace IRP – 32.441 1 [38], 32.442 [110], 32.446 [111] + +The Trace IRP supports the operations that are required for the Subscriber and Equipment trace, the Cell Traffic Trace, Minimization of Drive Tests (MDT) functionalities across UMTS networks or EPS networks and Radio Link Failure (RLF) reporting functionalities across EPS networks. GSM Trace is outside of the scope of this specification. + +## 7.3 QoE measurements + +### 7.3.1 Overview and relationships to management services + +- QoE measurement collection; specifications + + - Concepts, use cases and requirements (**28.404**) + - Control and configuration (**28.405**) + - Information definition and transport (**28.406**) + +Figure 7.3.1-1: QoE related Specifications + +### 7.3.2 QoE specifications + +#### **QoE measurement collection – Concepts, use cases and requirements – TS 28.404 [58]** + +One main motivation of mobile network evolution is to improve the user experience why the evaluation of the user experience 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), 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 3GPP TS 26.247 [188]) 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 for analysis and/or KPI calculations. + +#### **QoE measurement collection – Control and Configuration – TS 28.405 [59]** + +TS 28.405 [59] addresses the mechanisms used for the function Quality of Experience (QoE) measurement collection in UMTS and LTE. The measurements that are collected are DASH and MTSI 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. + +#### **QoE measurement collection – Information definition and transport – TS 28.406 [60]** + +TS 28.406 [60] 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. + +# --- 8 Relationships between IRPs + +Relationships between Interface IRPs: + +- All Interface IRPs utilizing the functionality of the Generic IRP +- All notification emitting Interface IRPs utilizing the functionality of the Notification IRP + +Relationships between NRM IRPs: + +- For FMC-enabled NRM IRP, the Generic NRM IRP is utilizing functionality of the FMC FNIM Umbrella Information Model (UIM) +- All NRM IRPs utilizing the functionality of the Generic NRM IRP +- All function-specific NRM IRPs (e.g. Core NRM IRP) utilizing the functionality of the Inventory NRM IRP + +# 9 SON functions + +In order to reduce the operating expenses (OPEX) associated with the management of increasing number of nodes from more than one vendor the concept 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 OPEX by reducing manual involvement in such tasks. + +SON functions are Radio Access Technology (RAT) dependent. Generally, SON functions are applicable to E-UTRAN network, and can be applied to UTRAN network on a case by case basis. The following specifications have identified the use cases and requirements in context of SON for standardization: + +- Self-establishment of an eNodeB: Related requirements are defined in TS 32.501 [36]; +- Automatic Neighbour Relation Management: Related requirements are defined in TS 32.511 [28]; +- Self-Optimisation Management: Related requirements are defined in TS 32.521 [29] or TS 28.627 [35]; +- Self-Healing Management: Related requirements are defined in TS 32.541 [30]; +- Energy Saving Management: Related requirements are defined in TS 32.551 [31]; +- Minimization of Drive Tests: Related requirements are defined in TS 32.421 [37] and TS 32.441 [38]. + +Each SON use case can involve multiple IRPs when corresponding management scenarios are applied. As to IRP solution fulfilment, Self-Optimization Management, Self-Healing Management and Energy Saving Management share the common information model of SON policy NRM (TS 32.522 [119]), while each one also has RAT-dependent information model in E-UTRAN NRM (TS 32.761 [137], 32.762 [138], 32.766 [139] /28.657 [154], 28.658 [155], 28.659 [156]) or UTRAN NRM (TS 32.641 [131], 32.642 [132], 32.646 [133], 28.651 [148], 28.652 [149], 28.653 [150]). The IRP relationships of SON functions and measurement definitions are addressed case by case as follows, + +## Self-establishment of an eNodeB + +Interface IRPs: + +- SC IRP (32.500 [27], 32.501 [36], 32.502 [117], 32.506 [118]) +- Software Management IRP (32.531 [121], 32.532 [122], 32.536 [123]) +- Generic IRP (32.311 [71], 32.312 [72], 32.316 [73]) +- Alarm IRP (32.111-1 [22], 32.111-2 [63], 32.111-6 [64]) +- Test Management IRP (32.321 [74], 32.322 [75], 32.326 [76]) +- Basic CM IRP (32.600 [32], 32.601 [7], 32.602 [8], 32.603 [9], 32.606 [124]) or Bulk CM IRP (32.611 [125], 32.612 [126], 32.616 [127]) +- Kernel CM IRP (32.661 [134], 32.662 [135], 32.666 [136]) +- Notification IRP (32.300 [25], 32.301 [68], 32.302 [69], 32.306 [70]) +- File Transfer IRP (for ARCF data download) (32.341 [80], 32.342 [81], 32.346 [82]) + +NRM IRPs: + +- Umbrella Information Model (28.620 [34]) +- Generic NRM IRP (32.621 [128], 32.622 [129], 32.626 [130] or 28.621 [10], 28.622 [11], 28.623 [12]) +- E-UTRAN NRM IRP (32.761 [137], 32.762 [138], 32.766 [139] or 28.657 [154], 28.658 [155], 28.659 [156]) + +## Automatic Neighbour Relation Management + +Interface IRP: + +- Basic CM IRP (32.600 [32], 32.601 [7], 32.602 [8], 32.603 [9], 32.606 [124]) or Bulk CM IRP (32.611 [125], 32.612 [126], 32.616 [127]) +- Alarm IRP (32.111-1 [22], 32.111-2 [63], 32.111-6 [64]) +- Kernel CM IRP (32.661 [134], 32.662 [135], 32.666 [136]) +- Notification IRP (32.300 [25], 32.301 [68], 32.302 [69], 32.306 [70]) + +### NRM IRP: + +- Generic NRM IRP (32.621 [128], 32.622 [129], 32.626 [130] or 28.620 [34], 28.621 [10], 28.622 [11], 28.623 [12]) +- E-UTRAN NRM IRP (32.761 [137], 32.762 [138], 32.766 [139] or 28.657 [154], 28.656 [153], 28.659 [156]) +- UTRAN NRM IRP (32.641 [131], 32.642 [132], 32.646 [133]) + +## Self-Optimisation Management + +### Interface IRP: + +- Basic CM IRP (32.600 [32], 32.601 [7], 32.602 [8], 32.603 [9], 32.606 [124]) or Bulk CM IRP (32.611 [125], 32.612 [126], 32.616 [127]) +- Alarm IRP (32.111-1 [22], 32.111-2 [63], 32.111-6 [64]) +- PM IRP (32.410 [100], 32.411 [101], 32.412 [102], 32.416 [103]) +- File Transfer IRP (for PM data upload) (32.341 [80], 32.342 [81], 32.346 [82]) +- Kernel CM IRP (32.661 [134], 32.662 [135], 32.666 [136]) +- Notification IRP (32.300 [25], 32.301 [68], 32.302 [69], 32.306 [70]) + +### NRM IRP: + +- SON Policy NRM IRP (32.521 [29], 32.522 [119], 32.526 [120] or 28.627 [35], 28.628 [143], 28.629 [144]) +- Generic NRM IRP (32.621 [128], 32.622 [129], 32.626 [130] or 28.620 [34], 28.621 [10], 28.622 [11], 28.623 [12]) +- E-UTRAN NRM IRP (32.761 [137], 32.762 [138], 32.766 [139] or 28.657 [154], 28.656 [153], 28.659 [156]) + +### Measurement Definitions: + +- E-UTRAN Performance Measurements (32.425 [105]) + +## Self-Healing Management + +### Interface IRP: + +- Basic CM IRP (32.600 [32], 32.601 [7], 32.602 [8], 32.603 [9], 32.606 [124]) or Bulk CM IRP (32.611 [125], 32.612 [126], 32.616 [127]) +- Alarm IRP (32.111-1 [22], 32.111-2 [63], 32.111-6 [64]) +- Kernel CM IRP (32.661 [134], 32.662 [135], 32.666 [136]) +- Notification IRP (32.300 [25], 32.301 [68], 32.302 [69], 32.306 [70]) + +### NRM IRP: + +- SON Policy NRM IRP (32.521 [29], 32.522 [119], 32.526 [120] or 28.627 [35], 28.628 [143], 28.629 [144]) + +- Generic NRM IRP (32.621 [128], 32.622 [129], 32.626 [130] or 28.620 [34], 28.621 [10], 28.622 [11], 28.623 [12]) +- E-UTRAN NRM IRP (32.761 [137], 32.762 [138], 32.766 [139] or 28.657 [154], 28.656 [153], 28.659 [156]) + +## Energy Saving Management + +Interface IRP: + +- Basic CM IRP (32.600 [32], 32.601 [7], 32.602 [8], 32.603 [9], 32.606 [124]) or Bulk CM IRP (32.611 [125], 32.612 [126], 32.616 [127]) +- PM IRP (32.410 [100], 32.411 [101], 32.412 [102], 32.416 [103]) +- File Transfer IRP (for PM data upload) (32.341 [80], 32.342 [81], 32.346 [82]) +- Kernel CM IRP (32.661 [134], 32.662 [135], 32.666 [136]) +- Notification IRP (32.300 [25], 32.301 [68], 32.302 [69], 32.306 [70]) + +NRM IRP: + +- SON Policy NRM IRP (32.521 [29], 32.522 [119], 32.526 [120] or 28.627 [35], 28.628 [143], 28.629 [144]) +- Generic NRM IRP (32.621 [128], 32.622 [129], 32.626 [130] or 28.620 [34], 28.621 [10], 28.622 [11], 28.623 [12]) +- E-UTRAN NRM IRP (32.761 [137], 32.762 [138], 32.766 [139] or 28.657 [154], 28.656 [153], 28.659 [156]) +- UTRAN NRM IRP (32.641 [131], 32.642 [132], 32.646 [133]) + +Measurement Definitions: + +- E-UTRAN Performance Measurements (32.425 [105]) +- UTRAN Performance Measurements (32.405 [95]) + +## Minimization of Drive Tests + +Interface IRP: + +- Trace Management IRP (32.441 [38], 32.442 [110], 32.446 [111]) +- Trace Control and Configuration Management IRP (32.421 [37], 32.422 [57], 32.423 [104]) +- Basic CM IRP (32.600 [32], 32.601 [7], 32.602 [8], 32.603 [9], 32.606 [124]) or Bulk CM IRP (32.611 [125], 32.612 [126], 32.616 [127]) +- Kernel CM IRP (32.661 [134], 32.662 [135], 32.666 [136]) + +NRM IRP: + +- Generic NRM IRP (32.621 [128], 32.622 [129], 32.626 [130] or 28.620 [34], 28.621 [10], 28.622 [11], 28.623 [12]) +- UTRAN NRM IRP (32.641 [131], 32.642 [132], 32.646 [133] or 28.651 [148], 28.652 [149], 28.653 [150]) +- E-UTRAN NRM IRP (32.761 [137], 32.762 [138], 32.766 [139] or 28.657 [154], 28.656 [153], 28.659 [156]) + +# 10 Network Function Virtualization (NFV) + +## 10.1 Overview + +### Concept, architecture and requirements + +- **Concept, architecture and requirements for mobile networks that include virtualized network functions (28.500)** + +### Configuration Management + +- **Requirements (28.510)** +- **Procedures (28.511)** +- **Stage 2 (28.512)** +- **Stage 3 (28.513)** + +### Fault Management + +- **Requirements (28.515)** +- **Procedures (28.516)** +- **Stage 2 (28.517)** +- **Stage 3 (28.518)** + +### Performance Management + +- **Requirements (28.520)** +- **Procedures (28.521)** +- **Stage 2 (28.522)** +- **Stage 3 (28.523)** + +### Life Cycle Management + +- **Requirements (28.525)** +- **Procedures (28.526)** +- **Stage 2 (28.527)** +- **Stage 3 (28.528)** + +## 10.2 Specifications + +### **Concept, architecture and requirements for mobile networks that include virtualized network functions – 28.500 [189]** + +The purpose of this specification is to describe 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. + +### **Configuration Management (CM) for mobile networks that include virtualized network functions – 28.510[190], 28.511 [191], 28.512 [192], 28.513 [193]** + +The purpose of these specifications is to define the requirements, procedures, stage 2 and 3 applicable to Configuration Management (CM) of mobile networks that include virtualized network functions which can be part of EPC or IMS. + +### **Fault Management (FM) for mobile networks that include virtualized network functions – 28.515 [194], 28.516 [195], 28.517 [196], 28.518 [197]** + +The purpose of these specifications is to define the requirements, procedures, stage 2 and 3 applicable to Fault Management (FM) of mobile networks that include virtualized network functions which can be part of EPC or IMS. + +### **Performance Management (PM) for mobile networks that include virtualized network functions – 28.520[198], 28.521 [199], 28.522 [200], 28.523 [201]** + +The purpose of these specifications is to define the requirements, procedures, stage 2 and 3 applicable to Performance Management (PM) of mobile networks that include virtualized network functions which can be part of EPC or IMS. + +### **Life Cycle Management (LCM) for mobile networks that include virtualized network functions – 28.525 [202], 28.526 [203], 28.527 [204], 28.528 [205]** + +The purpose of these specifications is to define the requirements, procedures, stage 2 and 3 applicable to Life Cycle Management (LCM) of mobile networks that include virtualized network functions which can be part of EPC or IMS. + +# --- 11 Void + +# --- Annex A (Informative): Void + +# --- Annex B (normative): Features supported + +## B.1 Converged management support table + +Table B.1.1 below illustrates the "Converged Management" feature support by the individual TS. The intersection of table rows (TS numbers) and columns (features) contains the 3GPP Release number starting from where this feature is supported. + +Table B.1.1: Converged management feature support + +| TS number | Converged management support | +|-----------|------------------------------| +| 32.101 | Rel-11 | +| 32.103 | Rel-11 | +| 32.150 | Rel-11 | +| 32.107 | Rel-11 | +| 32.156 | Rel-11 | +| 32.157 | Rel-11 | +| 32.300 | Rel-11 | +| 28.390 | Rel-12 | +| 28.611 | Rel-12 | +| 28.612 | Rel-12 | +| 28.616 | Rel-12 | +| 28.620 | Rel-11 | +| 28.621 | Rel-11 | +| 28.622 | Rel-11 | +| 28.623 | Rel-11 | +| 28.624 | Rel-11 | +| 28.625 | Rel-11 | +| 28.626 | Rel-11 | +| 28.627 | Rel-11 | +| 28.628 | Rel-11 | +| 28.629 | Rel-11 | +| 28.631 | Rel-11 | +| 28.632 | Rel-11 | +| 28.633 | Rel-11 | +| 28.651 | Rel-11 | +| 28.652 | Rel-11 | +| 28.653 | Rel-11 | +| 28.654 | Rel-11 | +| 28.655 | Rel-11 | +| 28.656 | Rel-11 | +| 28.657 | Rel-11 | +| 28.658 | Rel-11 | +| 28.659 | Rel-11 | +| 28.661 | Rel-11 | +| 28.662 | Rel-11 | +| 28.663 | Rel-11 | +| 28.671 | Rel-11 | +| 28.672 | Rel-11 | +| 28.673 | Rel-11 | +| 28.674 | Rel-11 | +| 28.675 | Rel-11 | +| 28.676 | Rel-11 | +| 28.701 | Rel-11 | +| 28.702 | Rel-11 | +| 28.703 | Rel-11 | +| 28.704 | Rel-11 | +| 28.705 | Rel-11 | +| 28.706 | Rel-11 | +| 28.707 | Rel-11 | +| 28.708 | Rel-11 | +| 28.709 | Rel-11 | +| 28.731 | Rel-11 | +| 28.732 | Rel-11 | +| 28.733 | Rel-11 | +| 28.734 | Rel-11 | +| 28.735 | Rel-11 | +| 28.736 | Rel-11 | +| 28.751 | Rel-11 | +| 28.752 | Rel-11 | +| 28.753 | Rel-11 | + +## B.2 Network sharing management support table + +There are several use cases and scenarios for network sharing. Table B.2-1 identifies the list of specifications and the status of support with regards to network sharing that satisfy the 3GPP Stage 1 requirements as defined in the present document. + +Legend used in the table: + +- **Not Applicable (N/A):** +The specification is not relevant to network sharing: example TS 32.581 [206], TS 32.582 [207]. +- **Not supported: Not supported and no proposal to modify in this release:** +Needs modifications but might/will not be changed in this release. +- **Not required in this release:** The network sharing scenarios and requirements in the present document do not require support in **this release**. +- **Supported in this release:** +Specification modified to support network sharing scenarios. +- **Supported with no modification:** +The specification supports network sharing scenarios with no modifications. Examples are generic NRM. Even though this NRM is needed for supporting configuration management for a shared node, there is no change needed to the specification. +- **TBD:** Evaluation in progress. + +NOTE: Table B.2-1 is a skeleton and will be populated as the network sharing work is progressing. + +The intention of table B.2-1 is to cover all the 3GPP Technical Specifications (TS) with an evaluation remark on support for network sharing. If a TS does not appear in the table, it implies that the TS has not been evaluated for impact to support network sharing. + +**Table B.2-1: Network sharing feature support** + +| 3GPP TS Number | 3GPP specification Title | Support of network sharing scenarios | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| 28.403 | Performance Management; performance measurements for WLAN | Not required in this release.
Current SA2 standard does not support WLAN from different operators to be connected to the same CN nodes. | +| 28.611/612/616 | Evolved Packet Core (EPC) and non-3GPP access Interworking System Network Resource Model (NRM); Integration Reference Point (IRP); | Not required in this release.
Current SA2 standard does not support WLAN from different operators be connected to the same CN nodes | +| 28.620 | Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM) | Supported with no modification | +| 28.621/622/623 | Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Requirements | Supported with no modification | +| 28.624/625/626 | State management data definition Integration Reference Point (IRP) | Supported with no modification | +| 28.627/628/629 | Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); | Not required in this release. | +| 28.631/632/633 | Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP) | Not Applicable | +| 28.651/652/653 | Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP) | Supported in this release. | +| 28.654/655/656 | GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); | Supported in this release. | +| 28.657/658/659 | Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP) | Supported in this release. | +| 28.661/662/663 | Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); | Supported with no modification | +| 28.671/672/673 | Home Node B (HNB) Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP) | Not Applicable (no plan to apply network sharing concepts to Home Node B (HNB)). | +| 28.674/675/676 | Home enhanced Node B (HeNB) Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP) | Not Applicable (no plan to apply network sharing concepts to Home enhanced Node B (HeNB)). | + +| | | | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| 28.701/702/703 | Telecommunication management; Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP) | See 32.631/2/6. Not required in this release (Impact of GWCN, e.g. sharing of SGSN, on existing specs not addressed in this release). | +| 28.704/705/706 | Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements | Not required in this release. | +| 28.707/708/709 | Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP) | Not required in this release (Impact of GWCN, i.e. sharing of MME, on existing specs not addressed in this release). | +| 28.731/732/733 | Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP) | Not Applicable (no plan to apply network sharing concepts to transport network). | +| 28.734/735/736 | Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); | Not Applicable (no plan to apply network sharing concepts to signalling transport network). | +| 28.751/752/753 | Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements | Not Applicable | +| 32.101 | Principles and high level requirements | Supported with no modification. | +| 32.102 | Architecture | Supported with no modification. | +| 32.103 | Integration Reference Point (IRP) overview and usage guide | Supported with no modification | +| 32.107 | Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) | Supported with no modification | +| 32.111-1/2/3/6 | Fault Management; 3G fault management requirements | TBD | +| 32.121/122/126 | Advanced Alarm Management (AAM) Integration Reference Point (IRP): | TBD | +| 32.140 | Telecommunication management; Subscription Management (SuM) requirements | Not Applicable | +| 32.141 | Telecommunication management; Subscription Management (SuM) architecture | Not Applicable | +| 32.150 | Integration Reference Point (IRP) Concept and definitions | Supported with no modification | +| 32.153 | Integration Reference Point (IRP) technology specific templates, rules and guidelines | Supported with no modification | +| 32.154 | Backward and Forward Compatibility (BFC); Concept and definitions | Not Applicable | +| 32.155 | Requirements template | Supported with no modification | +| 32.156 | Fixed Mobile Convergence (FMC) model repertoire | Supported with no modification | + +| | | | +|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| 32.157 | Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template | Supported with no modification | +| 32.181/182 | Telecommunication management; User Data Convergence (UDC); Framework for Model Handling and Management | Not Applicable (no plan to apply network sharing concepts to UDC). | +| 32.300 | Configuration Management (CM); Name convention for Managed Objects | TBD | +| 32.301/302/306 | Configuration Management (CM); Notification Integration Reference Point (IRP) | Supported with no modification | +| 32.311/312/316 | Generic Integration Reference Point (IRP) management | Supported with no modification | +| 32.321/322/326 | Test management Integration Reference Point (IRP); | Supported with no modification | +| 32.331/332/336 | Notification Log (NL) Integration Reference Point (IRP) | Supported with no modification | +| 32.351/352/356 | Communication Surveillance (CS) Integration Reference Point (IRP) | Not Applicable | +| 32.361/362/366 | Entry Point (EP) Integration Reference Point (IRP); Requirements | Supported with no modification | +| 32.371/372/376 | Telecommunication management; Security Management concept and requirements | Supported with no modification | +| 32.381/382/386 | Telecommunication management; Partial Suspension of Itf-N Integration Reference Point (IRP); Requirements | Supported with no modification | +| 32.391/392/396 | Telecommunication management; Delta synchronization Integration Reference Point (IRP); Requirements | Supported with no modification | +| 32.401 | Telecommunication management; Performance Management (PM); Concept and requirements | Supported with no modification | +| 32.404 | Telecommunication management; Performance Management (PM); Performance measurements; Definitions and template | Supported with no modification | +| 32.405 | Telecommunication management; Performance Management (PM); Performance measurements; Universal Terrestrial Radio Access Network (UTRAN) | TBD | +| 32.406 | Telecommunication management; Performance Management (PM); Performance measurements; Core Network (CN) Packet Switched (PS) domain | Supported with no modification | + +| | | | +|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| 32.407 | Telecommunication management; Performance Management (PM); Performance measurements; Core Network (CN) Circuit Switched (CS) domain; UMTS and combined UMTS/GSM | Supported with no modification | +| 32.408 | Telecommunication management; Performance Management (PM); Performance measurements; Teleservice | Not Applicable | +| 32.409 | Telecommunication management; Performance Management (PM); Performance measurements; IP Multimedia Subsystem (IMS) | Not required in this release. | +| 32.410 | Telecommunication management; Key Performance Indicators (KPI) for UMTS and GSM | TBD | +| 32.411/412/416 | Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Requirements | Supported with no modification | +| 32.421/422/423 | Telecommunication management; Subscriber and equipment trace; | TBD | +| 32.425 | Telecommunication management; Performance Management (PM); Performance measurements Evolved Universal Terrestrial Radio Access Network (E-UTRAN) | TBD | +| 32.426 | Telecommunication management; Performance Management (PM); Performance measurements Evolved Packet Core (EPC) network | TBD | +| 32.432 | Telecommunication management; Performance measurement: File format definition | TBD | +| 32.435 | Telecommunication management; Performance measurement; eXtensible Markup Language (XML) file format definition | TBD | +| 32.436 | Telecommunication management; Performance measurement: Abstract Syntax Notation 1 (ASN.1) file format definition | TBD | +| 32.441/442/446 | Trace Management Integration Reference Point (IRP) | TBD | +| 32.450 | Key Performance Indicators (KPI) for Evolved Universal Terrestrial Radio Access Network (E-UTRAN): Definitions | TBD | +| 32.451 | Key Performance Indicators (KPI) for Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Requirements | TBD | + +| | | | +|------------------------------------|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| 32.452 | Performance Management (PM); Performance measurements Home Node B (HNB) Subsystem (HNS) | Not Applicable | +| 32.453 | Performance Management (PM); Performance measurements Home enhanced Node B (HeNB) Subsystem (HeNS) | Not Applicable | +| 32.454 | Key Performance Indicators (KPI) for the IP Multimedia Subsystem (IMS); Definitions | Not required in this release. | +| 32.455 | Key Performance Indicators (KPI) for the Evolved Packet Core (EPC); Definitions | Not required in this release. | +| 32.500 | Self-Organizing Networks (SON); Concepts and requirements | Not required in this release. | +| 32.501/502/506 | Self-configuration of network elements; Concepts and requirements | Supported with no modification | +| 32.511 | Automatic Neighbour Relation (ANR) management; | TBD (handling of ANR may be impacted by RAN sharing) | +| 521/522/526 | Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); | Not required in this release. | +| 32.531/532/536 | Software management (SwM); Concepts and Integration Reference Point (IRP) | Not Applicable | +| 32.541 | Self-Organizing Networks (SON); Self-healing concepts and requirements | Not Applicable | +| 32.551 | Energy Saving Management (ESM); Concepts and requirements | Not Applicable | +| 32.571/572 | Home Node B (HNB) and Home eNode B (HeNB) management; Type 2 interface | Not Applicable | +| 32.581/582/583/584 | Home Node B (HNB) Operations, Administration, Maintenance and Provisioning (OAM&P): Type 1 interface | Not Applicable | +| 32.591/592/593/594 | Home enhanced Node B (HeNB) Operations, Administration, Maintenance and Provisioning (OAM&P): Type 1 Interface | Not Applicable | +| 32.600/601/602/606 | Configuration Management (CM) | Supported with no modification | +| 32.611/612/616 | Configuration Management (CM); Bulk CM Integration Reference Point (IRP) | Supported with no modification | +| 32.621/622/626 | Configuration Management (CM); Generic network resources Integration Reference Point (IRP) | Not required in this release. | +| 32.631/632/636 | Configuration Management (CM); Core network resources Integration Reference Point (IRP) | Supported with no modification | +| 32.661/662/666 | Configuration Management (CM); Kernel CM | Supported with no modification | +| 32.690 | Telecommunication management; Inventory Management (IM); Requirements | Not Applicable | + +| | | | +|----------------|---------------------------------------------------------------------------------------------------|----------------| +| 32.691/692/696 | Inventory Management (IM)
Network Resource Model
(NRM) Integration
Reference Point (IRP) | Not Applicable | +|----------------|---------------------------------------------------------------------------------------------------|----------------| + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|----------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2010-12 | SP-50 | SP-100764 | -- | -- | Submitted to SA#50 for Information | 0.1.0 | 1.0.0 | +| 2011-05 | SP-52 | SP-110272 | -- | -- | Submitted to SA#52 for Approval | 1.2.0 | 2.0.0 | +| 2011-06 | SP-52 | -- | -- | -- | Publication | 2.0.0 | 10.0.0 | +| 2012-06 | SP-56 | SP-120370 | 001 | 2 | Add relation description between IRPs | 10.0.0 | 11.0.0 | +| 2012-12 | SP-58 | SP-120783 | 003 | 2 | CR R11 32.103 Add usage description for SON functions | 11.0.0 | 11.1.0 | +| 2013-03 | SP-59 | SP-130060 | 004 | 2 | Enhancements for Converged Management | 11.1.0 | 11.2.0 | +| 2013-09 | SP-61 | SP-130433 | 005 | 1 | correction of references | 11.2.0 | 11.3.0 | +| 2014-06 | SP-64 | SP-140332 | 006 | 2 | Add missing feature support matrix | 11.3.0 | 11.4.0 | +| | | SP-140359 | 007 | - | remove the feature support statements | | | +| 2014-10 | | | | | Automatic upgrade (MCC) | 11.4.0 | 12.0.0 | +| 2014-12 | SP-66 | SP-140798 | 009 | - | Remove the mapping information between 32 series and 28 series | 12.0.0 | 12.1.0 | +| | | | 010 | - | Add feature support statements for Rel-12 | | | +| | | SP-140797 | 012 | - | Update feature support statement for TS 32.300 | | | +| | | SP-140800 | 013 | 2 | Add annex for network sharing management support table | | | +| 2016-01 | | | | | Update to Rel-13 (MCC) | 12.1.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-12 | SA#74 | SP-160855 | 0015 | - | C | Alignment with latest SA5 specification list and various enhancements | 14.0.0 | +| 2018-01 | SA#78 | SP-170964 | 0016 | 1 | F | Update erroneous references | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | SA#88-e | SP-200486 | 0018 | 1 | F | Add 5G specification information | 15.1.0 | +| 2020-07 | SA#88-e | SP-200494 | 0017 | 1 | B | Add QoE Specifications | 16.0.0 | +| 2020-09 | SA#89e | SP-200728 | 0025 | 1 | A | Correction of reference list and adding references throughout the document | 16.1.0 | +| 2020-12 | SA#90e | SP-201048 | 0031 | - | A | Correction of reference in the document | 16.2.0 | +| 2022-03 | SA#95e | SP-220185 | 0033 | 1 | F | Remove 5G specification information | 16.3.0 | +| 2022-03 | - | - | - | - | - | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-04 | - | - | - | - | - | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/32_series/32111-1/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32111-1/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8bbe6bd6536a1907f853975d76b57228efc7ead8 --- /dev/null +++ b/marked/Rel-18/32_series/32111-1/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:697c0efc2eaeece90b3ee5184a75221ec4ae5c15999f38434b0353ce759137b2 +size 9576 diff --git a/marked/Rel-18/32_series/32111-1/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32111-1/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c253871498e73ee8546be5cc659d545e63b5d135 --- /dev/null +++ b/marked/Rel-18/32_series/32111-1/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1dbb18cc9b88b6b1b3abf7d2628269cab66a0fad7208ee355e47f1e2dc9896c4 +size 7302 diff --git a/marked/Rel-18/32_series/32111-1/e190b6ddb7c2e64b940749a1c5612256_img.jpg b/marked/Rel-18/32_series/32111-1/e190b6ddb7c2e64b940749a1c5612256_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..40c16e39f3894bb5bd5746e748182d6145f53bc2 --- /dev/null +++ b/marked/Rel-18/32_series/32111-1/e190b6ddb7c2e64b940749a1c5612256_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f8814bd680018c63e9a0d5daf77d6afc01313f28ac7cec8e8413eaa6d624098 +size 43614 diff --git a/marked/Rel-18/32_series/32111-1/raw.md b/marked/Rel-18/32_series/32111-1/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..247afe59f0bd68241b6c536fee2321d9b002c593 --- /dev/null +++ b/marked/Rel-18/32_series/32111-1/raw.md @@ -0,0 +1,792 @@ + + +# 3GPP TS 32.111-1 V18.0.0 (2024-04) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Fault Management; Part 1: 3G fault management requirements (Release 18)** --- + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a large '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +## --- **Keywords** + +UMTS, management, alarm + +## **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. + +© 2024, 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..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 8 | +| 4 Fault Management concept and requirements ..... | 8 | +| 4.0 Introduction ..... | 8 | +| 4.1 Faults and alarms..... | 8 | +| 4.1.0 Introduction ..... | 8 | +| 4.1.1 Fault detection ..... | 9 | +| 4.1.2 Generation of alarms ..... | 10 | +| 4.1.3 Clearing of alarms ..... | 10 | +| 4.1.4 Alarm forwarding and filtering ..... | 11 | +| 4.1.5 Storage and retrieval of alarms in/from the NE..... | 12 | +| 4.1.6 Fault Recovery..... | 12 | +| 4.1.7 Configuration of Alarms..... | 13 | +| 4.1.8 Correlation of Alarms and Events ..... | 13 | +| 4.1.9 Root Cause Analysis..... | 14 | +| 4.1.10 Managed Alarm..... | 14 | +| 4.2 State Management..... | 15 | +| 4.2.0 Introduction ..... | 15 | +| 4.2.1 Propagation of state change..... | 16 | +| 4.3 Test management..... | 16 | +| 4.4 Operators' alarm handling..... | 17 | +| 4.5 Quality of Alarms..... | 17 | +| 5 N interface (Itf-N) ..... | 18 | +| 5.1 Fault Management concept of Itf-N ..... | 18 | +| 5.2 Management of alarm event reports..... | 19 | +| 5.2.1 Mapping of alarm and related state change event reports ..... | 19 | +| 5.2.2 Real-time forwarding of event reports..... | 19 | +| 5.2.3 Alarm clearing ..... | 19 | +| 5.3 Retrieval of alarm information..... | 20 | +| 5.3.0 Introduction ..... | 20 | +| 5.3.1 Retrieval of current alarm information on NM request..... | 20 | +| 5.3.2 Logging and retrieval of alarm history information on NM request ..... | 20 | +| 5.4 Co-operative alarm acknowledgement on the Itf-N..... | 20 | +| 5.5 Overview of IRPs related to Fault Management (FM) ..... | 21 | +| Annex A (informative): General principles of alarm generation ..... | 22 | +| Annex B (informative): Change history..... | 23 | + +# Foreword + +This Technical Specification (TS) 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: + +- 32.111-1 "Fault Management; Part 1: 3G fault management requirements".** +- 32.111-2 "Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- 32.111-3 "Fault Management; Part 3: Alarm Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)". +- 32.111-6 "Fault Management; Part 6: Alarm Integration Reference Point (IRP): Solution Set (SS) definitions". + +The present document is part of a TS-family, which describes the requirements and information model necessary for the Telecommunication Management (TM) of 3GPP systems. The TM principles and TM architecture are specified in 3GPP TS 32.101 [2] and 3GPP TS 32.102 [3]. + +A 3GPP system is composed of a multitude of Network Elements (NE) of various types and, typically, different vendors, which inter-operate in a co-ordinated manner in order to satisfy the network users' communication requirements. + +The occurrence of failures in a NE may cause a deterioration of this NE's function and/or service quality and will, in severe cases, lead to the complete unavailability of the respective NE. In order to minimize the effects of such failures on the Quality of Service (QoS) as perceived by the network users it is necessary to: + +- detect failures in the network as soon as they occur and alert the operating personnel as fast as possible; +- isolate the failures (autonomously or through operator intervention), i.e. switch off faulty units and, if applicable, limit the effect of the failure as much as possible by reconfiguration of the faulty NE/adjacent NEs; +- if necessary, determine the cause of the failure using diagnosis and test routines; and, +- repair/eliminate failures in due time through the application of maintenance procedures. + +This aspect of the management environment is termed "Fault Management" (FM). The purpose of FM is to detect failures as soon as they occur and to limit their effects on the network Quality of Service (QoS) as far as possible. + +The latter is achieved by bringing additional/redundant equipment into operation, reconfiguring existing equipment/NEs, or by repairing/eliminating the cause of the failure. + +Fault Management (FM) encompasses all of the above functionalities except commissioning/decommissioning of NEs and potential operator triggered reconfiguration (these are a matter of Configuration Management (CM), cf. TS 32.600 [19]). + +FM also includes associated features in the Operations System (OS), such as the administration of a pending alarms list, the presentation of operational state information of physical and logical devices/resources/functions, and the provision and analysis of the alarm and state history of the network. + +# 1 Scope + +The present document specifies the overall requirements for 3GPP Fault Management (FM) as it applies to the Network Elements (NE), Element Manager (EM) and Network Manager (NM). + +Clause 4 defines the FM concept and functional requirements for the detection of faults and the generation, collection and presentation of alarms, operational state data and test results across 3GPP systems. These functions are described on a non-formal level since the formal standardization of these functions across the different vendors' equipment is not required. The functional areas specified in the present document cover: + +- fault surveillance and detection in the NEs; +- notification of alarms (including alarm cease) and operational state changes; +- retrieval of current alarms from the NEs; +- fault isolation and defence mechanisms in the NEs; +- alarm filtering; +- management of alarm severity levels; +- alarm and operational state data presentation and analysis at the Operations System (OS); +- retention of alarm and operational state data in the NEs and the OS; and +- the management of tests. + +Any (re)configuration activity exerted from the EM as a consequence of faults will not be subject of the present document. These are described in [19]. + +Clause 5 of the present document defines the functional requirements for the standard Itf-N, for the purpose of Fault Management of 3GPP systems , as seen from the Network Manager (NM). The Itf-N is fully standardized so as to connect systems of any vendor to the NM via this 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 32.601: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Requirements". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements". +- [5] Void. +- [6] Void. + +- [7] Void. +- [8] Void. +- [9] ITU-T Recommendation X.733: "Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function". +- [10] Void. +- [11] ITU-T Recommendation X.735: "Information technology - Open Systems Interconnection - Systems Management: Log control function". +- [12] ITU-T Recommendation X.745: "Information technology - Open Systems Interconnection - Systems Management: Test management function". +- [13] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP); Information Service (IS)". +- [14] Void. +- [15] Void. +- [16] Void. +- [17] Void. +- [18] NGMN Top OPE Recommendations V1.0. +- [19] 3GPP TS 32.600: "Configuration Management (CM); Concept and high-level requirements". +- [20] 3GPP TS 28.625: "State management data definition Integration Reference Point (IRP); Information Service (IS)". +- [21] 3GPP TS 32.302: "Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)". +- [22] 3GPP TS 32.332: "Notification Log (NL) Integration Reference Point (IRP); Information Service (IS)". +- [23] ANSI/ISA standard 18.2 -2009: "Management of Alarm Systems for the Process Industries ". +- [24] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 21.905 [24] and the following apply: + +**active alarm:** An alarm that has not been cleared and which is active until the fault that caused the alarm is corrected and a "clear alarm" is generated. + +**ADAC Faults:** Faults that are "Automatically Detected and Automatically Cleared" by the system when they occur and when they are repaired. + +**ADMC Faults:** Faults that are Automatically Detected by the system when they occur and Manually Cleared by the operator when they are repaired. + +**alarm:** An alarm signifies an undesired condition of a resource (e.g. network element, link) for which an operator action is required. It emphasizes a key requirement that operators (above Itf-N) should not be informed about an undesired condition unless it requires operator action. Use of this emphasis does not exclude this case: In certain + +context, it is not possible for alarm reporters (below Itf-N) to know whether a particular undesired condition requires operator action or not. In such context, the NM may receive alarms that do not require operator action. + +**alarm notification:** Notification used to inform the recipient about the occurrence of an alarm. + +**clear alarm:** Alarm where the severity value is set to "cleared". + +**event:** Network occurrence which has significance for the management of an NE. Events do not have state. + +**event notification:** Notification used to inform the recipient about the occurrence of an event. +**fault:** A deviation of a system from normal operation, which may result in the loss of operational capabilities of the element or the loss of redundancy in case of a redundant configuration. + +**Itf-N:** Management interface defined in 3GPP TS 32.101 [2] subclause 5.1.2.2 and 3GPP TS 32.102 [3] subclause 7.3.2. + +**managed alarm:** The management representation of the alarm in the NM domain. + +**notification:** Information message originated below Itf-N. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 21.905 [24] 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 32.101 [2], 3GPP TS 32.102 [3] and 3GPP TS 21.905 [24], in that order. + +| | | +|------|--------------------------------------------------| +| ADAC | Automatically Detected and Automatically Cleared | +| ADMC | Automatically Detected and Manually Cleared | +| CM | Configuration Management | +| EM | Element Manager | +| FM | Fault Management | +| HMA | Highly Managed Alarm | +| ISO | International Standards Organisation | +| IRP | Integration Reference Point | +| MMI | Man-Machine Interface | +| MOC | Managed Object Class | +| MOI | Managed Object Instance | +| NE | Network Element | +| NM | Network Manager | +| OS | Operations System | +| QoS | Quality of Service | +| TMN | Telecommunications Management Network | + +# 4 Fault Management concept and requirements + +## 4.0 Introduction + +Any evaluation of the NEs' and the overall network health status require the detection of faults in the network and, consequently, the notification of alarms to the OS (EM and/or NM). Depending on the nature of the fault, it may be combined with a change of the operational state of the logical and/or physical resource(s) affected by the fault. + +Detection and notification of these state changes is as essential as it is for the alarms. A list of active alarms in the network and operational state information as well as alarm/state history data are required by the system operator for further analysis. Additionally, test procedures can be used in order to obtain more detailed information if necessary, or to verify an alarm or state or the proper operation of NEs and their logical and physical resources. + +The following clauses explain the detection of faults, the handling of alarms and state changes and the execution of tests. + +Only those requirements covered by clause 5 and related IRPs shall be considered as valid requirements for compliance to the standard defined by the present document. + +## 4.1 Faults and alarms + +### 4.1.0 Introduction + +Faults that may occur in the network can be grouped into one of the following categories: + +- Hardware failures, i.e. the malfunction of some physical resource within a NE. +- Software problems, e.g. software bugs, database inconsistencies. +- Functional faults, i.e. a failure of some functional resource in a NE and no hardware component can be found responsible for the problem. +- Loss of some or all of the NE's specified capability due to overload situations. +- Communication failures between two NEs, or between NE and OS, or between two OSs. + +In any case, as a consequence of faults, appropriate alarms related to the physical or logical resource(s) affected by the fault(s), shall be generated by the network entities. + +The following clauses focus on the aspects of fault detection, alarm generation and storage, fault recovery and retrieval of stored alarm information. + +### 4.1.1 Fault detection + +When any type of fault described above occurs within a 3GPP system, the affected network entities shall be able to detect them immediately. + +The network entities accomplish this task using autonomous self-check circuits/procedures, including, in the case of NEs, the observation of measurements, counters and thresholds. The threshold measurements may be predefined by the manufacturer and executed autonomously in the NE, or they may be based on performance measurements administered by the EM, cf. [4]. The fault detection mechanism as defined above shall cover both active and standby components of the network entities. + +The majority of the faults should have well-defined conditions for the declaration of their presence or absence, i.e. fault occurrence and fault clearing conditions. Any such incident shall be referred to in the present document as an ADAC fault. The network entities should be able to recognize when a previously detected ADAC fault is no longer present, i.e. the clearing of the fault, using similar techniques as they use to detect the occurrence of the fault. For some faults, no clearing condition exists. For the purpose of the present document, these faults shall be referred to as ADMC faults. An example of this is when the network entity has to restart a software process due to some inconsistencies, and normal operation can be resumed afterwards. In this case, although the inconsistencies are cleared, the cause of the problem is not yet corrected. Manual intervention by the system operator shall always be necessary to clear ADMC faults since these, by definition, cannot be cleared by the network entity itself. + +For some faults there is no need for any short-term action, neither from the system operator nor from the network entity itself, since the fault condition lasted for a short period of time only and then disappeared. An example of this is when a NE detects the crossing of some observed threshold, and in the next sampling interval, the observed value stays within its limits. + +For each fault, the fault detection process shall supply the following information: + +- the device/resource/file/functionality/smallest replaceable unit as follows: + - for hardware faults, the smallest replaceable unit that is faulty; + - for software faults, the affected software component, e.g. corrupted file(s) or databases or software code; + - for functional faults, the affected functionality; + - for faults caused by overload, information on the reason for the overload; + - for all the above faults, wherever applicable, an indication of the physical and logical resources that are affected by the fault if applicable, a description of the loss of capability of the affected resource. + +- the type of the fault (communication, environmental, equipment, processing error, QoS) according to ITU-T Recommendation X.733 [9]; +- the severity of the fault (indeterminate, warning, minor, major, critical), as defined in ITU-T Recommendation X.733 [9]; +- the probable cause of the fault; +- the time at which the fault was detected in the faulty network entity; +- the nature of the fault, e.g. ADAC or ADMC; +- any other information that helps understanding the cause and the location of the abnormal situation (system/implementation specific). + +For some faults, additional means, such as test and diagnosis features, may be necessary in order to obtain the required level of detail. See clause 4.3 for details. + +### 4.1.2 Generation of alarms + +For each detected fault, appropriate alarms shall be generated by the faulty network entity, regardless of whether it is an ADAC or an ADMC fault. Such alarms shall contain all the information provided by the fault detection process as described in clause 4.1.1. + +Examples of criteria for setting the alarm severity to “critical” are [18]: + +- Total disturbance of the system or significant service impact for customers +- Performance, capacity, throughput restrictions +- Accounting disturbed + +Examples of criteria for setting the alarm severity to “major” are [18]: + +- Outage of a redundant component (e.g. outage of a redundant power supply) +- Introduction of retaliatory actions required, to ensure the service availability + +In order to ease the fault localization and repair, the faulty network entity should generate for each single fault, one single alarm, also in the case where a single fault causes a degradation of the operational capabilities of more than one physical or logical resource within the network entity. An example of this is a hardware fault, which affects not only a physical resource but also degrades the logical resource(s) that this hardware supports. In this case the network entity should generate one single alarm for the faulty resource (i.e. the resource which needs to be repaired) and a number of events related to state management (cf. clause 4.2) for all the physical/logical resources affected by the fault, including the faulty one itself. + +In case a network entity is not able to recognize that a single fault manifests itself in different ways, the single fault is detected as multiple faults and originates multiple alarms. In this case however, when the fault is repaired the network entity should be able to detect the repair of all the multiple faults and clear the related multiple alarms. + +When a fault occurs on the connection media between two NEs or between a NE and an OS, and affects the communication capability between such NE/OS, each affected NE/OS shall detect the fault as described in clause 4.1.1 and generate its own associated communication alarm toward the managing OS. In this case it is the responsibility of the OS to correlate alarms received from different NEs/OSs and localize the fault in the best possible way. + +Within each NE, all alarms generated by that NE shall be input into a list of active alarms. The NEs shall be able to provide such a list of active alarms to the OS when requested. + +### 4.1.3 Clearing of alarms + +The alarms originated in consequence of faults need to be cleared. To clear an alarm it is necessary to repair the corresponding fault. + +Alarm maintenance manuals must contain a clear repair action for the dedicated malfunction. The repair action shall also be populated in the corresponding alarm field (see [18]). + +Wherever possible, event-based automated repair actions to solve standard error situations without manual interaction should be implemented, if not already implemented on the Network Element level (see [18]). + +The procedures to repair faults are implementation dependent and therefore they are out of the scope of the present document, however, in general: + +- the equipment faults are repaired by replacing the faulty units with working ones; +- the software faults are repaired by means of partial or global system initializations, by means of software patches or by means of updated software loads; +- the communication faults are repaired by replacing the faulty transmission equipment or, in case of excessive noise, by removing the cause of the noise; +- the QoS faults are repaired either by removing the causes that degraded the QoS or by improving the capability of the system to react against the causes that could result in a degradation of the QoS; +- Solving the environmental problem repairs the environment faults (high temperature, high humidity, etc.). + +It is also possible that an ADAC fault is spontaneously repaired, without the intervention of the operator (e.g. a threshold crossed fault). In this case the NE behaves as for the ADAC faults repaired by the operator. + +In principle, the NE uses the same mechanisms to detect that a fault has been repaired, as for the detection of the occurrence of the fault. However, for ADMC faults, manual intervention by the operator is always necessary to clear the fault. Practically, various methods exist for the system to detect that a fault has been repaired and clear alarms and the faults that triggered them. For example: + +- The system operator implicitly requests the NE to clear a fault, e.g. by initializing a new device that replaces a faulty one. Once the new device has been successfully put into service, the NE shall clear the fault(s). Consequently, the NE shall clear all related alarms. +- The system operator explicitly requests the clearing of one or more alarms. Once the alarm(s) has/have been cleared, the fault management system (within EM and/or NE) should reissue those alarms (as new alarms) in case the fault situation still persists. +- The NE detects the exchange of a faulty device by a new one and initializes it autonomously. Once the new device has been successfully put into service, the NE shall clear the fault(s). Consequently, the NE shall clear all related alarms. +- The NE detects that a previously reported threshold crossed alarm is no longer valid. It shall then clear the corresponding active alarm and the associated fault, without requiring any operator intervention. The details for the administration of thresholds and the exact condition for the NE to clear a threshold crossed alarm are implementation specific and depend on the definition of the threshold measurement, see also subclause 4.1.1. +- ADMC faults/alarms can, by definition, not be cleared by the NE autonomously. Therefore, in any case, system operator functions shall be available to request the clearing of ADAC alarms/faults in the NE. Once an ADMC alarm/fault has been cleared, the NE shall clear the associated ADAC fault/alarm. + +Details of these mechanisms are system/implementation specific. + +Each time an alarm is cleared the NE shall generate an appropriate clear alarm event. A clear alarm is defined as an alarm, as specified in clause 3.1, except that its severity is set to "cleared". The relationship between the clear alarm and the active alarm is established: + +- by re-using a set of parameters that uniquely identify the active alarm (see clause 4.1.1); or +- by including a reference to the active alarm in the clear alarm. + +When a clear alarm is generated the corresponding active alarm is removed from the active alarm list. + +### 4.1.4 Alarm forwarding and filtering + +As soon as an alarm is entered into or removed from the active alarms list Alarm notifications shall be forwarded by the NE, in the form of unsolicited notifications; + +If forwarding is not possible at this time, e.g. due to communication breakdown, then the notifications shall be sent as soon as the communication capability has been restored. The storage space is limited. The storage capacity is Operator and implementation dependent. If the number of delayed notifications exceeds the storage space then an alarm synchronization procedure shall be run when the communication capability has been restored. + +The OS shall detect the communication failures that prevent the reception of alarms and raise an appropriate alarm to the operator. + +If the Itf-N is implemented in the NE, then the destination of the notifications is the NM, and the interface shall comply with the stipulations made in clause 5. If the Itf-N resides in the EM, proprietary means may be employed to forward the notifications to the EM. Note that, even if the Itf-N is implemented in the NE, the EM may still also receive the notifications by one of the above mechanisms. However, the present document does not explicitly require the NEs to support the EM as a second destination. + +The event report shall include all information defined for the respective event (see clauses 4.1.1, 4.1.2 and 4.1.3), plus an identification of the NE that generated the report. + +The system operator shall be able to allow or suppress alarm reporting for each NE. As a minimum, the following criteria shall be supported for alarm filtering: + +- the NE that generated the alarm, i.e. all alarm messages for that NE shall be suppressed; +- the device/resource/function to which the alarm relates; +- the severity of the alarm; +- the time at which the alarm was detected, i.e. the alarm time; and, +- any combination of the above criteria. + +The result of any command to modify the forwarding criteria shall be confirmed by the NE to the requesting operator. + +### 4.1.5 Storage and retrieval of alarms in/from the NE + +For Fault Management (FM) purposes, each NE shall have to store and retain the following information: + +- a list of all active alarms, i.e. all alarms that have not yet been cleared; and +- alarm history information, i.e. all notifications related to the occurrence and clearing of alarms. + +It shall be possible to apply filters when active alarm information is retrieved by the Manager and when the history information is stored by the NE and retrieved by the Manager. + +The storage space for alarm history in the NE is limited. Therefore it shall be organized as a circular buffer, i.e. the oldest data item(s) shall be overwritten by new data if the buffer is full. Further "buffer full" behaviours, e.g. those defined in ITU-T Recommendation X.735 [11], may be implemented as an option. The storage capacity itself, and thus the duration, for which the data can be retained, shall be Operator and implementation dependent. + +### 4.1.6 Fault Recovery + +After a fault has been detected and the replaceable faulty units have been identified, some management functions are necessary in order to perform system recovery and/or restoration, either automatically by the NE and/or the EM, or manually by the operator. + +The fault recovery functions are used in various phases of the Fault Management (FM): + +- 1) Once a fault has been detected, the NE shall be able to evaluate the effect of the fault on the telecommunication services and autonomously take recovery actions in order to minimize service degradation or disruption. + +- 2) Once the faulty unit(s) has (have) been replaced or repaired, it shall be possible from the EM to put the previously faulty unit(s) back into service so that normal operation is restored. This transition should be done in such a way that the currently provided telecommunication services are not, or only minimally, disturbed. +- 3) At any time the NE shall be able to perform recovery actions if requested by the operator. The operator may have several reasons to require such actions; e.g. he has deduced a faulty condition by analysing and correlating alarm reports, or he wants to verify that the NE is capable of performing the recovery actions (proactive maintenance). + +The recovery actions that the NE performs (autonomously or on demand) in case of faults depend on the nature and severity of the faults, on the hardware and software capabilities of the NE and on the current configuration of the NE. + +Faults are distinguished in two categories: software faults and hardware faults. In the case of software faults, depending on the severity of the fault, the recovery actions may be system initializations (at different levels), activation of a backup software load, activation of a fallback software load, download of a software unit etc. In the case of hardware faults, the recovery actions depend on the existence and type of redundant (i.e. back-up) resources. Redundancy of some resources may be provided in the NE in order to achieve fault tolerance and to improve system availability. + +If the faulty resource has no redundancy, the recovery actions shall be: + +- a) Isolate and remove from service the faulty resource so that it cannot disturb other working resources; +- b) Remove from service the physical and functional resources (if any) which are dependent on the faulty one. This prevents the propagation of the fault effects to other fault-free resources; +- c) State management related activities for the faulty resource and other affected/dependent resources cf. clause 4.2; +- d) Generate and forward appropriate notifications to inform the OS about all the changes performed. + +If the faulty resource has redundancy, the NE shall perform action a), c) and d) above and, in addition, the recovery sequence that is specific to that type of redundancy. Several types of redundancy exist (e.g. hot standby, cold standby, duplex, symmetric/asymmetric, N plus one or N plus K redundancy, etc.), and for each one, there is a specific sequence of actions to be performed in case of failure. The present document specifies the Fault Management aspects of the redundancies, but it does not define the specific recovery sequences of the redundancy types. + +In the case of a failure of a resource providing service, the recovery sequence shall start immediately. Before or during the changeover, a temporary and limited loss of service shall be acceptable. In the case of a management command, the NE should perform the changeover without degradation of the telecommunication services. + +The detailed definition of the management of the redundancies is out of the scope of the present document. If a fault causes the interruption of ongoing calls, then the interrupted calls shall be cleared, i.e. all resources allocated to these calls shall immediately be released by the system. + +### 4.1.7 Configuration of Alarms + +It shall be possible to configure the alarm actions, thresholds and severities by means of commands, according to the following requirements: + +- the operator shall be able to configure any threshold that determines the declaration or clearing of a fault. If a series of thresholds are defined to generate alarms of various severities, then for each alarm severity the threshold values shall be configurable individually. +- it shall be possible to modify the severity of alarms defined in the system, e.g. from major to critical. This capability should be implemented on the manager, however, in case it is implemented on the NE, the alarms forwarded by the NE to the OS and the alarms displayed on the local MMI shall have the same severity. + +The NE shall confirm such alarm configuration commands and shall notify the results to the requesting system operator. + +### 4.1.8 Correlation of Alarms and Events + +A single network fault may result in the generation of multiple alarms and events from affected entities over time and spread over a wide geographical area. If possible, the OS should indicate which alarms and events are correlated to each other. + +Alarms may be correlated in view of certain rules such as alarm propagation path, specific geographical area, specific equipment, or repeated alarms from the same source. The alarms are partitioned into sets where alarms within one correlated set have a high probability of being caused by the same network fault. A correlated set may also contain events. These events are considered having a high probability of being related to the same network fault. + +The correlation describes relations between network events (e.g. current alarms as those captured in AlarmList, historical alarms as those captured in NotificationLog, network configuration changes). + +### 4.1.9 Root Cause Analysis + +For a set of correlated alarms, one alarm may relate to the fault which is the root cause of all the correlated alarms and events. If possible, the OS should perform a Root Cause Analysis to identify and indicate the Root Cause Alarm. + +Root Cause Analysis is a process that can determine and identify the network condition (e.g. fault, mis-configuration) causing the alarms. The determination may be based on the following (for example): + +- Information carried in alarm(s); +- Information carried in correlated alarm sets; +- Information carried in network notifications; +- Network configuration information; +- Operators' network management experience. + +### 4.1.10 Managed Alarm + +The alarm severities set by the network elements (NEs) in a mobile system, visible across the Itf-N, are basically resource focused (e.g. severity is set to major if NE available capacity is low). Vast amount of alarms classified as critical are potentially sent to operator's management centers but are rarely critical from the overall business perspective. They may even not be critical from the aspect of time to respond. + +An operator's view can obviously be very different from the alarm severity defined by the NEs' resource focused views. + +Operators need to enrich the information, i.e. the NE's resource focused view, for the purpose of the alarm management processes, see ref. [23]. The figure 4.1.10 introduces the concept of Managed Alarm, the management representation of the alarm in the NM domain (above Itf-N). + +![Diagram illustrating the flow of alarms from Network Elements (NEs) through an IRP Agent, across an interface (Itf-N), to an IRP Manager within the Network Management (NM) domain. The diagram shows the transformation of resource-focused alarms into service-impact-focused managed alarms.](e190b6ddb7c2e64b940749a1c5612256_img.jpg) + +``` + +graph LR + subgraph NEs + NEs[NEs] --> IRPAgent[IRP Agent] + end + IRPAgent --> ItfN[Itf-N] + ItfN --> IRPManager[IRP Manager] + subgraph NM + IRPManager --> NM[NM] + end + NEs -.-> Callout1[Generate resource focused alarms.] + IRPAgent -.-> Callout2[Transfer resource focused alarms over Itf-N] + IRPManager -.-> Callout3[Transform resource focused severity to service impact focused severity. The transformed alarms are managed alarms or Highly Managed Alarms (HMAs).] + +``` + +Diagram illustrating the flow of alarms from Network Elements (NEs) through an IRP Agent, across an interface (Itf-N), to an IRP Manager within the Network Management (NM) domain. The diagram shows the transformation of resource-focused alarms into service-impact-focused managed alarms. + +Figure 4.1.10 + +Within the NM, the received resource alarms are transformed so that the alarm severity is no longer resource focused but service impact focused, to prevent or mitigate network and service outage and degradation. The transformation applies to all severity levels. + +A very special important class of managed alarm is the Highly Managed Alarm (HMA) class, introduced by the ANSI/ISA standard in ref. [23]. + +These HMAs are the most critical alarms, catastrophic from operations, security, business or any other top level point of view. These HMAs should receive special treatment particularly when it comes to viewing their status in the Human-Machine Interface (HMI). These are the alarms that shall never be allowed to be delayed or lost and must always be given the highest attention. + +Considerable high levels of administrative requirements are applicable for the HMAs. For companies following this standard, detailed documentation and a multitude of special administrative requirements in a precise way, need to be fulfilled. + +These include: + +- Specific shelving requirements, such as access control with audit trail; +- Specific "Out of Service" alarm requirements, such as interim protection, access control, and audit trail; +- Mandatory initial and refresher training with specific content and documentation; +- Mandatory initial and periodic testing with specific documentation; +- Mandatory training around maintenance requirements with specific documentation; +- Mandatory audit requirements. + +The HMA classes are also subject to special requirements for operator training, frequency of testing, and archiving of alarm records for proof of regulatory compliance. + +Millions of mobile customers are from time to time affected by major failures in the infrastructure of mobile systems. Service assurance management of the continuously increasing complexity of our mobile systems could benefit from concepts like HMAs. The most critical equipment should be identified and secured. The HMAs should be treated in the most thoughtful way. The HMAs should never be hidden, delayed etc. in e.g. alarm flooding. + +Setup of HMAs, within the scope and responsibility of the NM, will include many of the processes identified in the alarm management lifecycle, see ref. [23]. + +## 4.2 State Management + +### 4.2.0 Introduction + +The State Management is a common service and used by several management areas, including Fault Management. In this clause, some detailed requirements on State Management as they apply to the Fault Management are defined. + +From the point of view of Fault Management, only two of the three primary state attributes are really important: the Administrative state and the Operational state. In addition the resources may have some secondary "status" attributes which give further detailed information about the reason of the primary state. + +The Administrative state is used by the Operator to make a resource available for service, or to remove a resource from service. For example: + +- for fault correction the Administrative state can be used to isolate a faulty resource; +- in case of redundancy the Administrative state can be used to lock the active resource and let the standby resource to become active (preventive maintenance); +- for Test management the Administrative state can be used to put a resource out of service to run an intrusive test on it. + +The Operational state gives the information about the real capability of a resource to provide or not provide service. + +- The operational state is "enabled" when the resource is able to provide service, "disabled" when the resource cannot provide service. + +- A resource can lose the capability to provide service because of a fault or because another resource on which it depends is out of service (e.g. disabled or locked). +- In case a resource does not lose completely its capability to provide service, the Operational state shall be "enabled" and the Availability status shall be "degraded". + +The changes of the state and status attributes of a resource shall be notified to the relative manager(s) as specified in TS 28.625 [20]. + +When a state change is originated by a failure, the alarm notification and the related state change notifications shall be correlated to each other by means of explicit relationship information. + +### 4.2.1 Propagation of state change + +Within a managed element, when for any reason a resource changes its state, the change shall be propagated, in a consistent way, to all the other resources that are functionally dependent on the first one. Therefore: + +- In case of a fault occurring on a resource makes that resource completely out of service, if the current operational state is "enabled", it shall be changed to "disabled" and a state change notification shall be generated. Then, all the dependent resources (following the fault dependency diagram specific to that managed element) shall be checked and, in case they are "enabled" they shall be changed to "disabled". In this process, also the secondary status shall be changed consistently, in a way that it shall be possible to distinguish whether an object is disabled because it is faulty or because of it is functionally dependent on another object which is disabled. +- In case a faulty resource is repaired, the Operational state of that resource is changed from "disabled" to "enabled" and all the dependent resources are turned back to "enabled" (this is the simple case). In more complex cases, some of the objects may be disabled for different causes (different faults or faults plus locks on different superior resources), in this cases the repaired resource can be turned "enabled" only when all the causes are cleared (i.e. faults are repaired and superior resources are unlocked). Also in this process the secondary status shall be changed consistently. +- In case the operator locks a resource, the process of the state change propagation is similar to the first case (resource failure) except for the locked resource which does not change its operational state but only the administrative state from "unlocked" to "locked". The dependent resources are processed as in the first case. +- In case the operator unlocks a resource, the process of the state change propagation is similar to the second case (fault reparation) except for the first resource (the unlocked one) which does not change its operational state but only the administrative state from "locked" to "unlocked". The dependent resources are processed as in the first case. + +## 4.3 Test management + +This management function provides capabilities that can be used in different phases of the Fault Management (FM). For example: + +- when a fault has been detected and if the information provided through the alarm report is not sufficient to localize the faulty resource, tests can be executed to better localize the fault; +- during normal operation of the NE, tests can be executed for the purpose of detecting faults; +- once a faulty resource has been repaired or replaced, before it is restored to service, tests can be executed on that resource to be sure that it is fault free. + +However, regardless of the context where the testing is used, its target is always the same: verify if a system's physical or functional resource performs properly and, in case it happens to be faulty, provide all the information to help the operator to localize and correct the faults. + +Testing is an activity that involves the operator, the managing system (the OS) and the managed system (the NE). Generally the operator requests the execution of tests from the OS and the managed NE autonomously executes the tests without any further support from the operator. + +In some cases, the operator may request that only a test bed is set up (e.g. establish special internal connections, provide access test points, etc.). The operator can then perform the real tests, which may require some manual support to handle + +external test equipment. Since the "local maintenance" and the "inter NE testing" are out of the scope of the present document, this aspect of the testing is not treated any further. + +The requirements for the test management service are based on ITU-T Recommendation X.745 [12], where the testing description and definitions are specified. + +## 4.4 Operators' alarm handling + +A 3GPP system is composed of a multitude of network elements of various types and with a variety of complexity. The purpose of FM is to detect failures as soon as they occur and to limit their effects on the network Quality of Service (QoS) as far as possible. + +Alarm Surveillance of the network is the first line Network Management Assurance Activity and is often maintained in near real time. The very essence of the surveillance functionality is to alert the operating personnel when failures appear in the networks. This is emphasized by the following sentence from 3GPP TS 32.101 [2] clause 7.5.2 Standardisation objectives: + +"In order to minimise the effects of such failures on the QoS as perceived by the network users it is necessary to detect failures in the network as soon as they occur and alert the operating personnel as fast as possible;" + +The operating personnel are confronted with most of the alarm notifications. It is of significant importance that the alarms are of operational relevance otherwise valuable time and resources will be spent to identify the irrelevant alarms. + +Operator response to an alarm may consist of many different steps such as: + +- Recognizing the alarm; +- Acknowledging the alarm; +- Verifying that the alarm is valid and not a malfunction; +- Getting enhanced information related to the alarm; +- Analysing the situation in order to try to determine the cause of the alarm, potential service impact and decide upon actions on the alarm. This may include reporting/activating other people from the second line support; +- Taking actions which may include activating reset of network elements, replacing the faulty equipment, creating trouble reports, etc; +- Continuing the surveillance of the network element(s) to ensure the fault correction. + +The alarm notifications are basically a human-machine interface and a common expectation is that operators should never miss alarms requiring an operation action. To be able to fulfil such a request the goal is to only monitor the necessary alarms at the right time by extracting the relevant ones. + +The key criterion is that alarms must require an operator response – that is, an action. + +The expectation of alarm handling includes the following: + +- Few alarms; +- Alarms are clearly prioritized and presented to the operator; +- Each alarm requires a needed action; +- Each action is taken by the operator; +- Alarms suppression methods aid the operator to handle alarm flooding so that saturation of the alarm management systems will not happen and control of the network is never lost. + +## 4.5 Quality of Alarms + +The assumption to efficiently handle the potentially vast amount of alarms in a mobile system is that alarms must exist solely as a tool for the benefit of the operator, see clause 4.4. They are not to be configured as a miscellaneous recording tool or for the prime benefit of maintenance personal. + +The information carried in the alarm message should also be good enough to ultimately feed and partly enable automatic-correlation engines. However, alarm response is still not an automated process involving deterministic machines; it is a complex human cognitive process involving thought and analysis. The human factors involved in alarm response are subject to many variables. The quality of the alarm notifications is of fundamental importance to enable an efficient management of a mobile system. + +The key to secure the quality of the information presented to the operator is to present alarm notifications of high operational relevans, in a timely fashion. If e.g. secondary logs, status or performance data are provided, it must be possible to easily separate those from the alarms. + +Some of the characteristics that an alarm should have are summarized below: + +- Relevance i.e. not spurious or of low operational value; +- Uniqueness i.e. not duplicating another alarm; +- Timeliness i.e. not long before any response is needed or too late to do anything; +- Importance i.e. indicating the importance that the operator deals with the problem; +- Explicability i.e. having a message which is clear and easy to understand; +- Recognizance i.e. identifying the problem that has occurred; +- Guidance i.e. indicative of the action to be taken; +- Prioritization i.e. drawing attention to the most important issues. + +# --- 5 Fault Management over Itf-N + +## 5.1 Fault Management concept + +An operations system on the network management layer (i.e. the NM) provides fault management services and functions required by the operator on top of the element management layer. + +The Itf-N may connect the Network Management (NM) system either to Element Managers (EMs) or directly to the Network Elements (NEs). This is done by means of Integration Reference Points (IRPs). In the following, the term "subordinate entities" defines either EMs or NEs, which are in charge of supporting the Itf-N. + +This clause describes the properties of an interface enabling a NM to supervise a 3GPP system including - if necessary - the managing EMs. To provide to the NM the Fault Management capability for the network implies that the subordinate entities have to provide information about: + +- events and failures occurring in the subordinate entities; +- events and failures of the connections towards the subordinate entities and also of the connections within the 3GPP system ; +- the network configuration (due to the fact that alarms and related state change information are always originated by network resources, see [19]). This is, however, not part of the FM functionality. + +Therefore, for the purpose of FM the subordinate entities send notifications to a NM indicating: + +- alarm reports (indicating the occurrence or the clearing of failures within the subordinate entities), so that the related alarm information can be updated; + +- state change event reports, so that the related (operational) state information can be updated. This is, however, not part of the FM functionality. + +The forwarding of these notifications is controlled by the NM operator using adequate filtering mechanisms within the subordinate entities. + +The Itf-N provides also means to allow the NM operator the storage ("logging") and the later evaluation of desired information within the subordinate entities. + +The retrieval capability of alarm-related information concerns two aspects: + +- retrieval of "dynamic" information (e.g. alarms, states), which describes the momentary alarm condition in the subordinate entities and allows the NM operator a synchronization of its alarm overview data; +- retrieval of "history" information from the logs (e.g. active/clear alarms and state changes occurred in the past), which allows the evaluation of events that may have been lost, e.g. after an Itf-N interface failure or a system recovery. + +As a consequence of the requirements described above, both the NM and the subordinate entity shall be able to initiate the communication. + +## 5.2 Management of alarm event reports + +### 5.2.1 Mapping of alarm and related state change event reports + +The alarm and state change reports received by the NM relate to functional objects in accordance with the information model of Itf-N. This information model tailored for a multi-vendor capability is different from the information model of the EM-NE interface (if an EM is available) or from the internal resource modelling within the NE (in case of direct NM-NE interface). Thus a mapping of alarm and related state change event reports is performed by a mediation function within the subordinate entity. + +The mediation function translates the original alarm/state change event reports (which may contain proprietary parameters or parameter values) taking into account the information model of the Itf-N. + +The following examples describe potential mediation function behaviour: + +- Alarm notifications generated by a functional object in a subordinate entity can be mapped to alarm reports of the corresponding ("equivalent") functional object at the Itf-N. If the functional object generating the original alarm notification has not a direct corresponding object at the Itf-N, the mediation functions maps the alarm to the next superior functional object in accordance with the containment tree of the Itf-N. +- State change notifications generated by a functional object in a subordinate entity can be mapped to state change reports of the corresponding ("equivalent") functional object at the Itf-N. If the functional object generating the original state change notification has not a direct corresponding object at the Itf-N, the mediation functions maps the alarm to the next superior functional object in accordance with the containment tree of the Itf-N. + +Every alarm notification generated by a manufacturer-specific, equipment-related object in the subordinate entity is mapped to an alarm report of a generic logical object, which models the corresponding equipment-related resource. + +### 5.2.2 Real-time forwarding of event reports + +If the Itf-N is in normal operation (the NM connection to the subordinate entities is up), alarm reports are forwarded in real-time to the NM via appropriate filtering located in the subordinate entity. These filters may be controlled either locally or remotely by the managing NM (via Itf-N) and ensure that only the event reports which fulfil pre-defined criteria can reach the superior NM. In a multi-NM environment each NM shall have an own filter within every subordinate entity which may generate notifications. + +### 5.2.3 Alarm clearing + +On the Itf-N, alarm reports containing the value "cleared" of the parameter perceivedSeverity are used to clear the alarms. The correlation between the clear alarm and the related active alarms is performed by means of unambiguous identifiers. + +This clearing mechanism ensures the correct clearing of alarms, independently of the (manufacturer-specific) implementation of the mapping of alarms/state change events in accordance with the information model of the Itf-N. + +The IRP manager may also clear alarms manually. + +## 5.3 Retrieval of alarm information + +### 5.3.0 Introduction + +The retrieval of alarm information comprises two aspects: + +- Retrieval of current information: + +This mechanism shall ensure data consistency about the current alarm information between the NM and its subordinate entities and is achieved by means of a so-called synchronization ("alignment") procedure, triggered by the NM. The synchronization is required after every start-up of the Itf-N, nevertheless the NM may trigger it at any time. + +- Logging and retrieval of history information: + +This mechanism offers to the NM the capability to get the alarm information stored within the subordinate entities for later evaluation. + +### 5.3.1 Retrieval of current alarm information on NM request + +The present document defines a flexible, generic synchronization procedure, which fulfils the following requirements: + +- The alarm information provided by means of the synchronization procedure shall be the same (at least for the mandatory parameters) as the information already available in the alarm list. The procedure shall be able to assign the received synchronization-alarm information to the correspondent requests, if several synchronization procedures triggered by one NM run at the same time. +- The procedure shall allow the NM to trigger the start at any time and to recognize unambiguously the end and the successful completion of the synchronization. +- The procedure shall allow the NM to discern easily between an "on-line" (spontaneous) alarm report and an alarm report received as consequence of a previously triggered synchronization procedure. +- The procedure shall allow the NM to specify filter criteria in the alignment request (e.g. for a full network or only a part of it). +- The procedure shall support connections to several NM and route the alignment-related information only to the requesting NM. +- During the synchronization procedure new ("real-time") alarms may be sent at any time to the managing NM. +- If the EM loses confidence to its alarm list and rebuilds it, then the EM shall indicate to the NM that the alarm list have been rebuilt. If the rebuild of the alarm list only concerns alarms for e.g. one NE then the EM may indicate that it is only that part of the alarm list that has been rebuilt. In the latter case the NM may use the knowledge that only a specific subset of the alarm list has been rebuilt to perform a partial resynchronization using filters. + +If applicable, an alarm synchronization procedure may be aborted by the requesting NM. + +### 5.3.2 Logging and retrieval of alarm history information on NM request + +The alarm history information may be stored in the subordinate entities. The NM is able to create logs for alarm reports and to define the criteria for storage of alarm information according to ITU-T Recommendation X.735 [11]. + +Nevertheless these particular requirements are not specific for alarm or state change information. + +The alarm history information should be returned by files when IRP agent finished collecting all the alarm history information that NM requested. + +## 5.4 Co-operative alarm acknowledgement on the Itf-N + +The acknowledgement of an alarm is a maintenance function that aids the operators in his day-to-day management activity of his network. An alarm is acknowledged by the operator to indicate he has started the activity to resolve this specific problem. In general a human operator performs the acknowledgement, however a management system (NM or EM) may automatically acknowledge an alarm as well. + +The alarm acknowledgement function requires that: + +- a) All involved OSs have the same information about the alarms to be managed (including the current responsibility for alarm handling). +- b) All involved OSs have the capability to send and to receive acknowledgement messages associated to previous alarm reports. + +A co-operative alarm acknowledgement means that the acknowledgement performed at EM layer is notified at NM layer and vice versa, thus the acknowledgement-related status of this alarm is the same across the whole management hierarchy. The OSs often gives the operator(s) a possibility to add a comment to an alarm. An OS can have the capability to record more than one comment for each alarm. To make the same alarm look the same in all OSs subscribing to the alarm, it should be possible to distribute the recorded comments in the same way as for the acknowledgement information. + +The co-operative alarm acknowledgement on Itf-N shall fulfil the following requirements: + +- Acknowledgement messages may be sent in both directions between EMs and NM, containing the following information: + - Correlation information to the alarm just acknowledged. + - Acknowledgement history data, including the current alarm state (active | cleared), the time of alarm acknowledgement and, as configurable information, the management system (EM | NM) and the operator in charge of acknowledgement (the parameter operator name or, in case of auto-acknowledgement, a generic system name). + - Acknowledgement notifications sent to NM shall be filtered with the same criteria applied to the alarms. +- Taking into account the acknowledgement functionality, the above described synchronization procedure for retrieval of current alarm information on NM request may be extended. Additionally to the requirements defined in clause 5.3.1, this extended synchronization procedure relates not only to the active, but also to the "cleared and not acknowledged" alarms, which have still to be managed by the EM. + +## 5.5 Overview of IRPs related to Fault Management (FM) + +The Itf-N is built up by a number of IRPs. The basic structure of the IRPs is defined in 3GPP TS 32.101 [2] and 3GPP TS 32.102 [3]. + +For the purpose of FM, the following IRPs are needed: + +- Alarm IRP, see 3GPP TS 32.111-2 [13]; +- Notification IRP, see [21]; and +- Notification Log (NL) IRP, see [22]. + +NOTE: The Notification Log (NL) IRP is not part of Release 1999, therefore the requirements related to the log functionality are not valid for Release 1999). + +# --- Annex A (informative): General principles of alarm generation + +This annex, as additional guidelines to subclause 4.1.2, lists and explains some general principles of alarm generation. + +The definition of 'alarm' can be found in subclause 3.1. + +- Alarm should convey the identified management entity information to operator + +For the faults of cell, carrier, channel, port, etc., if these faults need operator action, alarms need to be generated. Alarm location information should be accurate enough to identify the units which can be repaired or replaced by the maintenance staff. + +- No alarms for those faults that occurred once and then disappeared + +Faults that have occurred only once and then disappeared should not be reported as alarms, because these faults need no operator action. For example, for single call establishment failure, single handover failure or single call drop alarms are not needed since these faults usually only occur once and will not last permanently. Instead these events should be captured by performance measurement counters. + +- No alarms for those faults that were self-healed + +For the faults that cannot be perceived by operator, for example some internal software faults like stack overflow, loss of messages, insufficient memory, etc., no alarms are needed if these faults were fixed by network entity's self-healing actions such as software restart, since these faults need no operator action. However, as the service usually is negatively impacted by these faults before they are self-healed, these faults should be recorded into the related logs. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| Mar 2000 | SA_07 | SP-000013 | -- | -- | 32.111 Approved at TSG SA#7 and placed under Change Control | 2.0.0 | 3.0.0 | +| Mar 2000 | -- | -- | -- | -- | cosmetic | 3.0.0 | 3.0.1 | +| Jun 2000 | SA_08 | SP-000247 | 001 | -- | Split of TS 32.111 - Part 1: Main part of spec – Requirements | 3.0.1 | 3.1.0 | +| Jun 2000 | SA_08 | SP-000248 | 002 | -- | Split of TS 32.111- Part 1: Merged Clause X into Clause 4 | 3.0.1 | 3.1.0 | +| Jun 2000 | SA_08 | SP-000249 | 003 | -- | Split of TS 32.111 - Part 1: Alignment of FM requirements with IRP, etc | 3.0.1 | 3.1.0 | +| Sep 2000 | SA_09 | SP-000437 | 001 | -- | Clarification On Mediation Function Algorithms | 3.1.0 | 3.2.0 | +| Sep 2000 | SA_09 | SP-000437 | 002 | -- | Clarification On Clear Alarm Suppression | 3.1.0 | 3.2.0 | +| Jun 2001 | SA_12 | SP-010282 | 003 | -- | Added two new features 'partial resynchronization' or 'ltf-N distribution of comments associated to faults'. | 3.2.0 | 4.0.0 | +| Mar 2002 | SA_15 | -- | -- | -- | Automatic upgrade to Rel-5 (no Rel-5 CR) | 4.0.0 | 5.0.0 | +| Sep 2002 | SA_17 | SP-020477 | 004 | -- | Add requirements for new clearAlarms() operation in Alarm IRP | 5.0.0 | 5.1.0 | +| Dec 2002 | -- | -- | -- | -- | Updated references & cosmetics | 5.1.0 | 5.1.1 | +| Dec 2003 | SA_22 | SP-030631 | 005 | -- | Add retrieval of alarm history information requirement | 5.1.1 | 6.0.0 | +| Jun 2005 | -- | -- | -- | -- | Foreword, Introduction update : added 32.111-5 new TS-family member | 6.0.0 | 6.0.1 | +| Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. Cleaned-up references. | 6.0.1 | 7.0.0 | +| Mar 2009 | SA_43 | SP-090207 | 006 | -- | Include reference to SOAP Solution Set specification | 7.0.0 | 8.0.0 | +| Dec 2009 | SA_46 | -- | -- | -- | Upgrade to Rel-9 | 8.0.0 | 9.0.0 | +| Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 | +| Sep 2011 | SA_53 | SP-110534 | 007 | - | Add concepts for Alarm Correlation and Root Cause Analysis | 10.0.0 | 10.1.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 10.1.0 | 11.0.0 | +| 2013-06 | SA_60 | SP-130272 | 008 | 1 | Addition of criteria for critical and major alarms (compliance Top OPE) | 11.0.0 | 12.0.0 | +| | | | 010 | 1 | Addition of requirements on repair actions (compliance Top OPE) | | | +| 2014-12 | SA_66 | SP-140801 | 011 | 1 | Alarm quality improvements, new definitions and concepts for alarm handling | 12.0.0 | 12.1.0 | +| 2015-03 | SA_67 | SP-150060 | 016 | 1 | Replacement of obsolete term "N interface" | 12.1.0 | 12.2.0 | +| 2016-01 | | | | | Update to Rel-13(MCC) | 12.2.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 | +| 2022-03 | - | - | - | - | - | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-04 | - | - | - | - | - | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/32_series/32122/07b17a620c75522d53916a11e12d1bff_img.jpg b/marked/Rel-18/32_series/32122/07b17a620c75522d53916a11e12d1bff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1d5688f18e3088022f2d5e1dacbdd327353815cd --- /dev/null +++ b/marked/Rel-18/32_series/32122/07b17a620c75522d53916a11e12d1bff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a5cea8386e123006befe406f38bbf42b17f2a2fde968b971442057ab17708857 +size 23408 diff --git a/marked/Rel-18/32_series/32122/088921fa3f5a44c8551815122517eefd_img.jpg b/marked/Rel-18/32_series/32122/088921fa3f5a44c8551815122517eefd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..66066222cd77dc36d25d999a9139c8c43095e30b --- /dev/null +++ b/marked/Rel-18/32_series/32122/088921fa3f5a44c8551815122517eefd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9970e4c45a738992e69414212508d021da22b4ae96193af322abc2dfaf32540 +size 21630 diff --git a/marked/Rel-18/32_series/32122/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg b/marked/Rel-18/32_series/32122/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0a9d18040a2071933e38c9eca94721a856821889 --- /dev/null +++ b/marked/Rel-18/32_series/32122/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e27e1dcf3b17d94212e782d441ac5edb54df49692e20745045909b82b5b2fccf +size 40985 diff --git a/marked/Rel-18/32_series/32122/1320668e9151c5144f7e3696ae57e07f_img.jpg b/marked/Rel-18/32_series/32122/1320668e9151c5144f7e3696ae57e07f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1551c23bfc7023e1f5eb4a96d5c974fb6f7f98a5 --- /dev/null +++ b/marked/Rel-18/32_series/32122/1320668e9151c5144f7e3696ae57e07f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4b3bfa7d540ab416a38fdfc4e06f3faca96f44c5d30f2e58ddc8e558c77d20b5 +size 6854 diff --git a/marked/Rel-18/32_series/32122/410562339ce067fdc6fa41940c118658_img.jpg b/marked/Rel-18/32_series/32122/410562339ce067fdc6fa41940c118658_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..01a4b570cd8603c6a454855c40b88e9db252f4be --- /dev/null +++ b/marked/Rel-18/32_series/32122/410562339ce067fdc6fa41940c118658_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b4bc7239ea58557bad793e9c44528a58fc8f8d9f13ea78c98ef1977deee97408 +size 47031 diff --git a/marked/Rel-18/32_series/32122/47e75dc9e83054b2dac3df8bf3e57019_img.jpg b/marked/Rel-18/32_series/32122/47e75dc9e83054b2dac3df8bf3e57019_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b48eaf52c82aaa9d78d98376a7d80b1e5e65edca --- /dev/null +++ b/marked/Rel-18/32_series/32122/47e75dc9e83054b2dac3df8bf3e57019_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:668363e0aeb2512edcd09010917cb35da8e928d839f2c81ba29c2df604c23cd6 +size 14139 diff --git a/marked/Rel-18/32_series/32122/48a4d999034fb203698ddc187c259679_img.jpg b/marked/Rel-18/32_series/32122/48a4d999034fb203698ddc187c259679_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..94b177f3266831dc40975fac0662593b44c50fef --- /dev/null +++ b/marked/Rel-18/32_series/32122/48a4d999034fb203698ddc187c259679_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d2e655ab04bf08321880a987b103b9c8d932e54e0d212a9769d32da0bc3ed0b +size 21142 diff --git a/marked/Rel-18/32_series/32122/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32122/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bcfe5d2d6a391aa958fcabc8430ab5afd99d52e6 --- /dev/null +++ b/marked/Rel-18/32_series/32122/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9755410aa1361e1dca8998ebdb2d5c90e8fda9518b7ae67c77c9442011e81c52 +size 9200 diff --git a/marked/Rel-18/32_series/32122/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32122/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db8755fde8456c25374a71c900cccc297ad105af --- /dev/null +++ b/marked/Rel-18/32_series/32122/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a52172b47778c4db022378b6522427e771f28ba00f9753e9173afa0679274fb8 +size 5453 diff --git a/marked/Rel-18/32_series/32122/65f66758012e229247953202e8adf35d_img.jpg b/marked/Rel-18/32_series/32122/65f66758012e229247953202e8adf35d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..749f8a8c51fa450fe06780bab35130cfa7c70872 --- /dev/null +++ b/marked/Rel-18/32_series/32122/65f66758012e229247953202e8adf35d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8819221b6b6e6ad1afe2d32cde5a8e2941a839e97f4150efc2484fe7da52781 +size 10224 diff --git a/marked/Rel-18/32_series/32122/705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg b/marked/Rel-18/32_series/32122/705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3900e7e1bd091d1057012a58283b4128ef95be4a --- /dev/null +++ b/marked/Rel-18/32_series/32122/705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:caa685dab9db9dcfa77308f580711f90ace9e067f77912aad139871ea6b1312e +size 24268 diff --git a/marked/Rel-18/32_series/32122/731f533b0599c8e42a063f06e4332045_img.jpg b/marked/Rel-18/32_series/32122/731f533b0599c8e42a063f06e4332045_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..adff6921e530fd0eacbe13bc71c51b722ebd8054 --- /dev/null +++ b/marked/Rel-18/32_series/32122/731f533b0599c8e42a063f06e4332045_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77e5b1e77ab7560c85fefa7c76dd4215a3e4a40743e1a2418436fff7c283e17d +size 19026 diff --git a/marked/Rel-18/32_series/32122/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/Rel-18/32_series/32122/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..94421bbd83834e9c862c59cb66c34375cbca771e --- /dev/null +++ b/marked/Rel-18/32_series/32122/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5c342b73c683e42deb2d409ee60933387206217392e491fd432d80a94f7be10 +size 8685 diff --git a/marked/Rel-18/32_series/32122/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg b/marked/Rel-18/32_series/32122/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7253efd35866661904cbdc793b35a599ea94cd55 --- /dev/null +++ b/marked/Rel-18/32_series/32122/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98dc6ab39654b4716597910820cf933c03ae76a2a7fe41fe9cc08e52b447714c +size 22264 diff --git a/marked/Rel-18/32_series/32122/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-18/32_series/32122/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..579a62518fa5fb9ebd85f9d1b43dbb71c57a3e62 --- /dev/null +++ b/marked/Rel-18/32_series/32122/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:598a6ab1a0b4135c185bb78ae2877a8ce1e12c9804ba7d64019b33fb60bd17a8 +size 31004 diff --git a/marked/Rel-18/32_series/32122/bd4617f25d15430eb78c2d6d75a99dde_img.jpg b/marked/Rel-18/32_series/32122/bd4617f25d15430eb78c2d6d75a99dde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c4e414725265f1d089a22fdb2f66a69af46d2a3 --- /dev/null +++ b/marked/Rel-18/32_series/32122/bd4617f25d15430eb78c2d6d75a99dde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d71cfbad7ed8e1552980917854aa316feb5db8d7692c3b5581d7c4497030b92 +size 11240 diff --git a/marked/Rel-18/32_series/32122/c17eaf807acd5faec68da19dd16929be_img.jpg b/marked/Rel-18/32_series/32122/c17eaf807acd5faec68da19dd16929be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ccf8a2f994089ae0c809e72045aad4f5ba8a65e0 --- /dev/null +++ b/marked/Rel-18/32_series/32122/c17eaf807acd5faec68da19dd16929be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b35a5eac5af0aaf5e9bde9311ee938030676503308ab9732030255c01883945a +size 16800 diff --git a/marked/Rel-18/32_series/32122/c8e5b3ef81948bb13d5c6c3c326799ea_img.jpg b/marked/Rel-18/32_series/32122/c8e5b3ef81948bb13d5c6c3c326799ea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..76a393867b0f8d5a06609e40322ca32567472653 --- /dev/null +++ b/marked/Rel-18/32_series/32122/c8e5b3ef81948bb13d5c6c3c326799ea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf17457f3829d5bed557ad3dc2a49c2c29cdd457565d47e8163018c3a6350598 +size 16577 diff --git a/marked/Rel-18/32_series/32122/d369dc114803a761d452c13ee58ed579_img.jpg b/marked/Rel-18/32_series/32122/d369dc114803a761d452c13ee58ed579_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3cc49d2577f3b2e284afce31c3b76ea6c6da25b6 --- /dev/null +++ b/marked/Rel-18/32_series/32122/d369dc114803a761d452c13ee58ed579_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0a92b86d312797f2d1b58b4e4030d1663a52570887317df3840e0b49318b4aeb +size 13527 diff --git a/marked/Rel-18/32_series/32122/ec42effecdc5bce7bb2bf7a96c954845_img.jpg b/marked/Rel-18/32_series/32122/ec42effecdc5bce7bb2bf7a96c954845_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f0a39b81f2a8f6cca690794b2fecc41b6c032bd7 --- /dev/null +++ b/marked/Rel-18/32_series/32122/ec42effecdc5bce7bb2bf7a96c954845_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2118587ee09425bf71fecb68df1b023fe87ac9607400ac3ab0f9130b05ca31f9 +size 15648 diff --git a/marked/Rel-18/32_series/32122/f880daa1cde4b71fcbaff2df81803a65_img.jpg b/marked/Rel-18/32_series/32122/f880daa1cde4b71fcbaff2df81803a65_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df62d7e97be37ad6a9aa08e665c1775216c00d19 --- /dev/null +++ b/marked/Rel-18/32_series/32122/f880daa1cde4b71fcbaff2df81803a65_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9cc9ecba6fdc3ce292da5fe9a9e537a36a8f338cf80c267b5f048ae8f4321de9 +size 12847 diff --git a/marked/Rel-18/32_series/32122/raw.md b/marked/Rel-18/32_series/32122/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..60be81b635db86ba29bf169c68f299e49094ff5f --- /dev/null +++ b/marked/Rel-18/32_series/32122/raw.md @@ -0,0 +1,954 @@ + + +# 3GPP TS 32.122 V18.0.0 (2024-04) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP): Information Service (IS) (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +GSM, UMTS, 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. + +© 2024, 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 ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 System overview ..... | 8 | +| 4.1 System context ..... | 8 | +| 5 Information Object Classes..... | 9 | +| 5.1 Imported information entities and local labels..... | 9 | +| 5.2 Class diagram..... | 9 | +| 5.2.1 Attributes and relationships..... | 9 | +| 5.2.2 Inheritance ..... | 10 | +| 5.3 Information Object Class definitions ..... | 11 | +| 5.3.1 advancedAlarmManagementRule ..... | 11 | +| 5.3.1.1 Definition ..... | 11 | +| 5.3.1.1.1 General Definition ..... | 11 | +| 5.3.1.2 Attributes ..... | 11 | +| 5.3.2 advancedAlarmManagementIRP..... | 11 | +| 5.3.2.1 Definition ..... | 11 | +| 5.4 Information relationships definition..... | 12 | +| 5.4.1 relation- AdvancedAlarmManagementIRP-AdvancedAlarm ManagementRule (M) ..... | 12 | +| 5.4.1.1 Definition ..... | 12 | +| 5.4.1.2 Roles ..... | 12 | +| 5.4.1.3 Constraints ..... | 12 | +| 5.5 Information attributes definition ..... | 12 | +| 5.5.1 Definitions and legal values ..... | 12 | +| 6 Interface Definition ..... | 13 | +| 6.1 Class diagram representing interfaces..... | 13 | +| 6.2 AAMIRPOperation_1 Interface (M)..... | 14 | +| 6.2.1 Scope ..... | 14 | +| 6.2.2 Operation activateAAMRule (M)..... | 14 | +| 6.2.2.1 Definition ..... | 14 | +| 6.2.2.2 Input parameters ..... | 14 | +| 6.2.2.2.1 Generic Input parameters..... | 14 | +| 6.2.2.2.2 Content of Input parameter aAMRuleParameterList depending on value of aAMRuleType ..... | 14 | +| 6.2.2.2.2.1 aAMRuleType = ThresholdRule..... | 14 | +| 6.2.2.2.2.2 aAMRuleType = TransientRule..... | 15 | +| 6.2.2.2.2.3 aAMRuleType = ToggleRule..... | 15 | +| 6.2.2.2.2.4 aAMRuleType = vendorSpecificRule..... | 15 | +| 6.2.2.3 Output parameters..... | 15 | +| 6.2.2.4 Pre-condition..... | 15 | +| 6.2.2.5 Post-condition ..... | 15 | +| 6.2.2.6 Exceptions..... | 15 | +| 6.2.3 Operation getAAMRules (M)..... | 16 | +| 6.2.3.1 Definition ..... | 16 | +| 6.2.3.2 Input parameters ..... | 16 | +| 6.2.3.3 Output parameters..... | 16 | +| 6.2.3.4 Pre-condition..... | 16 | + +| | | | +|-------------------------------|------------------------------------------------|-----------| +| 6.2.3.5 | Post-condition ..... | 16 | +| 6.2.3.6 | Exceptions..... | 16 | +| 6.2.4 | Operation deactivateAAMRule (M)..... | 17 | +| 6.2.4.1 | Definition ..... | 17 | +| 6.2.4.2 | Input parameters ..... | 17 | +| 6.2.4.3 | Output parameters..... | 17 | +| 6.2.4.4 | Pre-condition..... | 17 | +| 6.2.4.5 | Post-condition ..... | 17 | +| 6.2.4.6 | Exceptions..... | 17 | +| Annex A (normative): | Advanced Alarm Management Rules..... | 18 | +| A.1 | General ..... | 18 | +| A.2 | AAM Rules ..... | 20 | +| A.2.1 | Threshold Rule ..... | 20 | +| A.2.1.1 | Parameters ..... | 20 | +| A.2.1.2 | Criterion to determine alike alarm..... | 20 | +| A.2.1.3 | Treatment of alike alarm..... | 20 | +| A.2.1.4 | Relation to Log and AlarmList..... | 21 | +| A.2.1.5 | Samples..... | 21 | +| A.2.1.6 | Example for Use cases..... | 21 | +| A.2.2 | Transient Rule ..... | 22 | +| A.2.2.1 | Parameters ..... | 22 | +| A.2.2.2 | Criterion to determine alike alarm..... | 22 | +| A.2.2.3 | Treatment of alike alarm..... | 22 | +| A.2.2.4 | Relation to Log and AlarmList..... | 22 | +| A.2.2.5 | Samples..... | 23 | +| A.2.2.6 | Example for Use cases..... | 23 | +| A.2.3 | Toggle Rule ..... | 24 | +| A.2.3.1 | Parameters ..... | 24 | +| A.2.3.2 | Criterion to determine alike alarm..... | 24 | +| A.2.3.3 | Treatment of alike alarm..... | 24 | +| A.2.3.4 | Relation to Log and AlarmList..... | 25 | +| A.2.3.5 | Samples..... | 25 | +| A.2.3.6 | Example for Use cases..... | 26 | +| A.2.3.7 | Exception Handling ..... | 27 | +| A.2.4 | Definition of vendor specific rule ..... | 27 | +| A.3 | Relation of Rule and Notification filter ..... | 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. + +# --- 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.121: Advanced Alarm Management (AAM) Integration Reference Point (IRP): Requirements; +- 32.122: Advanced Alarm Management (AAM) Integration Reference Point (IRP): Information Service (IS);** +- 32.126: Advanced Alarm Management (AAM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +The Itf-N interface is built up by a number of 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.150 [1]. + +A single network fault may generate a large number of alarms over space and time. In a large and complex network, simultaneous network faults may occur, causing the network operator to be flooded with high volume of alarms. The high volume of alarms, typically the one received by an IRPManager via the getAlarmList or alarm notifications of Alarm IRP specification, greatly inhibits the operator ability to quickly identify and locate the responsible network faults. AAM IRP is intended to provide methods to improve this situation. + +# --- 1 Scope + +The purpose of Advanced Alarm Management (AAM) IRP is to define an interface through which an IRPManager can categorize alarm notifications. + +The present document is the Information Service of AAM. It defines, for the purpose of categorizing alarm notifications, the information observable and controlled by management system's client and it also specifies the semantics of the interactions used to carry this information. + +# --- 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 TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [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.121: "Telecommunication management; Advanced Alarm Management Reference Point (IRP): Requirements". +- [5] void. +- [6] 3GPP TS 32.622: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)". +- [7] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)". +- [8] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (SS)". +- [9] 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 following terms and definitions apply: + +**IRP:** See 3GPP TS 32.150 [1]. + +**IRP Agent:** See 3GPP TS 32.150 [1]. + +**IRP Manager:** See 3GPP TS 32.150 [1]. + +**Alike Alarm:** Two alarms are considered alike, if the corresponding alarm notifications are issued by the same object instance with the same `alarmType`, same `perceivedSeverity`, same `probableCause` and same `specificProblem` (if present). + +**Lower Edge of Time Window:** The point in time which determines the begin of a time span. + +**Upper Edge of Time Window:** The point in time which determines the end of a time span. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|---------|--------------------------------| +| AAM | Advanced Alarm Management | +| AAMRule | Advanced Alarm Management Rule | +| CM | Configuration Management | +| EM | Element Manager | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| Itf-N | Interface N | +| MIB | Management Information Base | +| NE | Network Element | + +# 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 [1], clause 4.7. + +In addition, the set of related IRP(s) relevant to the present IRP is shown in figures 4.1-1 and 4.1-2. + +![Diagram of System Context A showing IRPManager (NM) connected to IRPAgent (EM) via Itf-N interface, with NEs connected to IRPAgent and Advanced Alarm Management IRP associated with the interface.](07b17a620c75522d53916a11e12d1bff_img.jpg) + +This diagram illustrates System Context A. On the left, a box labeled 'NM' contains an 'IRPManager'. On the right, a box labeled 'EM' contains an 'IRPAgent'. A solid horizontal line connects the 'IRPManager' and the 'IRPAgent'. To the right of the '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' boxes. A curved arrow points from the text 'Advanced Alarm Management IRP' to the 'Itf-N' interface line. + +Diagram of System Context A showing IRPManager (NM) connected to IRPAgent (EM) via Itf-N interface, with NEs connected to IRPAgent and Advanced Alarm Management IRP associated with the interface. + +Figure 4.1-1: System Context A + +![Diagram of System Context B showing IRPManager (NM) connected to IRPAgent (NE) via Itf-N interface, with Advanced Alarm Management IRP associated with the interface.](731f533b0599c8e42a063f06e4332045_img.jpg) + +This diagram illustrates System Context B. On the left, a box labeled 'NM' contains an 'IRPManager'. On the right, a box labeled 'NE' contains an 'IRPAgent'. A solid horizontal line connects the 'IRPManager' and the 'IRPAgent'. A vertical dashed line, labeled 'Itf-N' at its base, separates the 'NM' and 'NE' boxes. A curved arrow points from the text 'Advanced Alarm Management IRP' to the 'Itf-N' interface line. + +Diagram of System Context B showing IRPManager (NM) connected to IRPAgent (NE) via Itf-N interface, with Advanced Alarm Management IRP associated with the interface. + +Figure 4.1-2: System Context B + +# 5 Information Object Classes + +## 5.1 Imported information entities and local labels + +| Label reference | Local label | +|-----------------------------------------------------------------|-------------------| +| 3GPP TS 32.622 [6], information object class, Top | Top | +| 3GPP TS 32.312 [7], information object class, managedGenericIRP | managedGenericIRP | +| 3GPP TS 32.622 [6], information object class, IRPAgent | IRPAgent | + +## 5.2 Class diagram + +### 5.2.1 Attributes and relationships + +This clause depicts the set of IOC that encapsulate information within the AAM IRP. The intent is to identify the information required for the AAM IRP implementation of its operations and notification emission. + +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 AdvancedAlarmManagementIRP and AdvancedAlarmManagementRule classes.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` + +classDiagram + class AdvancedAlarmManagementIRP { + <> + } + class AdvancedAlarmManagementRule { + <> + aAMRuleIdentifier + aAMRuleType + aAMRuleParameterList + filter + } + AdvancedAlarmManagementIRP "1" *-- "0..*" AdvancedAlarmManagementRule + +``` + +The diagram shows two classes: **AdvancedAlarmManagementIRP** and **AdvancedAlarmManagementRule**. **AdvancedAlarmManagementIRP** is at the top, labeled with `<>`. **AdvancedAlarmManagementRule** is at the bottom, also labeled with `<>`, and contains four attributes: `aAMRuleIdentifier`, `aAMRuleType`, `aAMRuleParameterList`, and `filter`. A red line with a solid diamond at the top and an open arrow at the bottom connects the two classes, indicating a composition relationship. The multiplicity `0..*` is shown near the bottom class. + +UML Class Diagram showing AdvancedAlarmManagementIRP and AdvancedAlarmManagementRule classes. + +Figure 5.2.1-1: Class Diagram + +### 5.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between Information Object Classes. + +![Inheritance diagram showing AdvancedAlarmManagementRP inheriting from ManagedGenericRP.](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +``` +classDiagram + class ManagedGenericRP["<> ManagedGenericRP (from 32.622)"] + class AdvancedAlarmManagementRP["<> AdvancedAlarmManagementRP"] + AdvancedAlarmManagementRP --|> ManagedGenericRP +``` + +The diagram illustrates an inheritance relationship between two Information Object Classes. At the top is a box for **ManagedGenericRP** (from 32.622), labeled as **<>**. Below it is a box for **AdvancedAlarmManagementRP**, also labeled as **<>**. A vertical line with an open triangle arrowhead points from the bottom box to the top box, indicating that AdvancedAlarmManagementRP inherits from ManagedGenericRP. + +Inheritance diagram showing AdvancedAlarmManagementRP inheriting from ManagedGenericRP. + +Figure 5.2.2-1: Inheritance Diagram + +## 5.3 Information Object Class definitions + +### 5.3.1 advancedAlarmManagementRule + +#### 5.3.1.1 Definition + +##### 5.3.1.1.1 General Definition + +This information object represents an AAM Rule object instance. + +An AdvancedAlarmManagementRule is fully identified by its distinguished name. + +It inherits from IOC top. + +An AAM Rule is a way for the IRPManager to define which alarms / alarm clearings deliver significant or insignificant information (significant seen with the eyes of the IRPManager) and to tell the IRPAgent not to send the insignificant alarms / alarm clearings. + +AAMRules will not screen out all insignificant alarms/alarm clearings, but contribute to enable the network operator to reduce the number of reported alarms to a reasonable and manageable level. + +The choice of rule/s may depend on the type of alarm, the environment, the time of day and many more. + +To avoid screening of alarms which might be important for the network operator, the user of AAM rules should apply AAMrules with careful consideration and appropriate setting of parameters. + +An AAM Rule instance is fully identified by its DNdistinguished name. A Rule instance carries, among other things, the identification of the Rule type called AdvancedAlarmManagementRuleType. Of these there exist the following: + +- ThresholdRule +- TransientRule +- ToggleRule +- VendorSpecificRule + +See Annex A for the description of the above Rules. + +#### 5.3.1.2 Attributes + +| Attribute name | Support Qualifier | Read Qualifier | Write Qualifier | +|------------------------------------------|-------------------|----------------|-----------------| +| advancedAlarmManagementRuleIdentifier | M | M | - | +| advancedAlarmManagementRuleType | M | M | - | +| advancedAlarmManagementRuleParameterList | M | M | - | +| filter | M | M | - | + +### 5.3.2 advancedAlarmManagementIRP + +#### 5.3.2.1 Definition + +This information object represents an AAM IRP. It inherits from IOC managedGenericIRP. + +## 5.4 Information relationships definition + +### 5.4.1 relation- AdvancedAlarmManagementIRP-AdvancedAlarmManagementRule (M) + +#### 5.4.1.1 Definition + +This relationship defines the relationship between an AdvancedAlarmManagementIRP and an AdvancedAlarmManagementRule instance. + +#### 5.4.1.2 Roles + +| Name | Definition | +|--------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| theAdvancedAlarmManagementRule | This role represents an AAM Rule. It can be played by instances of IOC advancedAlarmingRule | +| theAdvancedAlarmManagementIRP | This role represents the AAM IRP which an IRPManager uses. It is played by instances of IOC advancedAlarm Management IRP | + +#### 5.4.1.3 Constraints + +None + +## 5.5 Information attributes definition + +This clause defines the semantics of the Attributes used in Information Object Classes. + +### 5.5.1 Definitions and legal values + +| Attribute Name | Definition | Legal Values | +|------------------------------------------|-------------------------------------------------------------------------|--------------| +| advancedAlarmManagementRuleIdentifier | This attribute identifies uniquely an AAM Rule base object instance | String | +| advancedAlarmManagementRuleType | This attribute indicates the type of AAM Rule this instance represents. | String | +| advancedAlarmManagementRuleParameterList | This attribute identifies parameters and values of this AAM Rule | N/A | + +# 6 Interface Definition + +## 6.1 Class diagram representing interfaces + +![UML Class Diagram showing AdvancedAlarmManagementIRP inheriting from AdvancedAlarmManagementIRPOperation_1 interface.](410562339ce067fdc6fa41940c118658_img.jpg) + +``` +classDiagram + class AdvancedAlarmManagementIRP { + <> + } + class AdvancedAlarmManagementIRPOperation_1 { + <> + activateAAMRule() + deactivateAAMRule() + getAAMRules() + } + AdvancedAlarmManagementIRP ..|> AdvancedAlarmManagementIRPOperation_1 +``` + +The diagram illustrates a class hierarchy. At the top is a class box labeled **AdvancedAlarmManagementIRP** with the stereotype **<>**. A dashed inheritance arrow points down to a second box. This second box is labeled **AdvancedAlarmManagementIRPOperation\_1** with the stereotype **<>**. Inside this interface box, three methods are listed: `activateAAMRule()`, `deactivateAAMRule()`, and `getAAMRules()`. + +UML Class Diagram showing AdvancedAlarmManagementIRP inheriting from AdvancedAlarmManagementIRPOperation\_1 interface. + +Figure 6.1-1: Class Diagram for AdvancedAlarmManagementIRPOperation\_1 Interface + +## 6.2 AAMIRPOperation\_1 Interface (M) + +### 6.2.1 Scope + +This interface defines methods for the IRPManager to request the IRPAgent for alarm notifications of significant information (significant from the IRPManager's perspective). + +The definition of insignificance is determined by the IRPManager. The choice of AAM Rule/s may depend on the type of alarm, the environment, the time of day and many more. + +An implementation can claim compliance to this IRP if it supports at least one of the AAMRules, i.e. one of the operations defined in clause 6.2.2 up to and including clause 6.2.5, and the mandatory operations defined in this interface. + +### 6.2.2 Operation activateAAMRule (M) + +#### 6.2.2.1 Definition + +This operation allows the IRPManager to request the IRPAgent to activate an AAM rule. + +#### 6.2.2.2 Input parameters + +##### 6.2.2.2.1 Generic Input parameters + +| Parameter Name | Qualifier | Information type | Comment | +|----------------------|-----------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aAMRuleType | M | N/A | This corresponds to attribute advancedAlarmManagementRuleType of advancedAlarmManagementRule (see 5.3.1.2)
Values: ThresholdRule, TransientRule, ToggleRule, VendorSpecificRule | +| aAMRuleParameterList | M | N/A | This corresponds to attribute advancedAlarmManagementRuleParameterList of advancedAlarmManagementRule (see 5.3.1.2)
Content depends on value of advancedAlarmManagementRuleType | +| filter | M | N/A | This corresponds to attribute filter of advancedAlarmManagementRule (see 5.3.1.2)
Carries a filter constraint. It can e.g. comprise objectClass, objectInstance, alarmType, probableCause, perceivedSeverity, specificProblem. | + +##### 6.2.2.2.2 Content of Input parameter aAMRuleParameterList depending on value of aAMRuleType + +###### 6.2.2.2.2.1 aAMRuleType = ThresholdRule + +| Parameter Name | Qualifier | Information type | Comment | +|-------------------------|-----------|------------------|---------------| +| alarmOccurenceThreshold | M | N/A | value >0 | +| slidingTimeWindow | M | N/A | Unit: minutes | + +###### 6.2.2.2.1.2 aAMRuleType = TransientRule + +| Parameter Name | Qualifier | Information type | Comment | +|----------------|-----------|------------------|---------------| +| timeSpan | M | N/A | Unit: minutes | + +###### 6.2.2.2.2.3 aAMRuleType = ToggleRule + +| Parameter Name | Qualifier | Information type | Comment | +|----------------------------------|-----------|------------------|---------------| +| alarmOccurenceThreshold | M | N/A | value>0 | +| slidingTimeWindowTogglingStarted | M | N/A | Unit: minutes | +| slidingTimeWindowTogglingSettled | M | N/A | Unit: minutes | + +###### 6.2.2.2.2.4 aAMRuleType = vendorSpecificRule + +| Parameter Name | Qualifier | Information type | Comment | +|----------------------------|-----------|------------------|---------| +| vendor specific parameters | N/A | N/A | N/A | + +#### 6.2.2.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|-------------------|-----------|-----------------------------------------------|------------| +| aAMRuleIdentifier | M | N/A | See §5.5.1 | +| status | M | ENUM (Success, Failure, aAMRuleAlreadyActive) | | + +#### 6.2.2.4 Pre-condition + +AAMIsSupported + +| Assertion Name | Definition | +|----------------|------------------------------------------------------| +| aAMIsSupported | The AAM functionality is supported by the IRP Agent. | + +#### 6.2.2.5 Post-condition + +AAMRuleIsApplied + +| Assertion Name | Definition | +|------------------|-------------------------------------------------------------------------------| +| aAMRuleIsApplied | The AAM rule is applied. For the consequences see the definitions in Annex A. | + +#### 6.2.2.6 Exceptions + +| Name | Properties | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | Condition: the pre-condition is false or the post-condition is false.
Returned Information: The output parameter status.
Exit state: Entry state. | + +### 6.2.3 Operation getAAMRules (M) + +#### 6.2.3.1 Definition + +This operation allows an IRPManager to request from the IRPAgent a list of activated AAMRules. + +#### 6.2.3.2 Input parameters + +None + +#### 6.2.3.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| aAMRuleList | M | LIST of aAMRuleInstance {
aAMRuleInstance
LIST OF {
aAMRuleIdentifier,
aAMRuleType,
aAMRuleParameterList,
filter
}
aAMRuleType
ENUM (
thresholdRule,
toggleRule,
transientRule,
vendorSpecificRule
)
aAMRuleParameterList:
Content type depends on the value of
aAMRuleType (see §6.2.2) | | +| Status | M | ENUM (Success, Failure) | If no rule is defined, an empty advancedAlarmManagementRuleList a shall be delivered and status==Success. | + +#### 6.2.3.4 Pre-condition + +None + +#### 6.2.3.5 Post-condition + +allActiveAdvanceAlarmManagementRulesAreDelivered + +| Assertion Name | Definition | +|-------------------------------------------|------------------------------------------------| +| allActiveAlarmManagementRulesAreDelivered | All active AAM rules are listed in the output. | + +#### 6.2.3.6 Exceptions + +| Name | Properties | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | Condition: the pre-condition is false or the post-condition is false.
Returned Information: The output parameter status.
Exit state: Entry state. | + +### 6.2.4 Operation deactivateAAMRule (M) + +#### 6.2.4.1 Definition + +This operation allows an IRPManager to request the IRPAgent to deactivate one or all activated AAMRules. + +Deactivated rules are not visible for the IRPManager. + +#### 6.2.4.2 Input parameters + +| Parameter Name | Qualifier | Information type | Comment | +|---------------------------------------|-----------|------------------|--------------------------------------------------------------------------------------------| +| advancedAlarmManagementRuleIdentifier | M | See 32.302 [3] | If this parameter contains no information, then all active AAM Rules shall be deactivated. | + +#### 6.2.4.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| status | M | ENUM (Success, SpecifiedRuleNotExisting, Failure) |

If input parameter advancedAlarmManagementRuleIdentifier is present and no such rule exists, then status==SpecifiedRuleNotExisting.

If input parameter advancedAlarmManagementRuleIdentifier is not present and no rule is defined, then status==Success.

| + +#### 6.2.4.4 Pre-condition + +None + +#### 6.2.4.5 Post-condition + +allOrSpecifiedActiveAdvanceAlarmManagementRulesAreDeactivated + +| Assertion Name | Definition | +|---------------------------------------------------------------|-------------------------------------------------------------------------------------| +| allOrSpecifiedActiveAdvanceAlarmManagementRulesAreDeactivated | Depending on the input all or only the specified active AAM Rule are/is deactivated | + +#### 6.2.4.6 Exceptions + +| Name | Properties | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed |

Condition: the pre-condition is false or the post-condition is false.

Returned Information: The output parameter status.

Exit state: Entry state.

| + +# Annex A (normative): Advanced Alarm Management Rules + +## A.1 General + +It is not recommended to have several AAMRules applicable at one time for one event. However, if YyyFunction supports and allows it, then it is vendor specific which AAMRule is applied or not. + +An AAMRule (called Rule hereafter) contains multiple elements. + +The first element (subSection titled: Criterion to determine alike alarm) is a criterion used to determine if an alarm is classified as 'alike' or "not alike". If the alarm is not-alike, then the alarm is not subject to further scrutiny (processing) by the Rule, i.e. it would be processed as if there is no Rule in effect. The IRPManager specifies such criterion in an input parameter named filter in various relevant AAM operations. + +The second element (subSection titled: Treatment of alike alarm) is the algorithm to determine if + +- a) An alike alarm should be reported as one alarm (i.e. it is a significant alarm) or +- b) The alike alarm should be suppressed (i.e. it is an insignificant alarm). + +When a significant alarm is identified, the algorithm also determines: + +- a) The time when the notifyNew/Changed/ClearedAlarm of this significant alarm should be sent to IRPManager and +- b) The value of alarmRaisedTime, alarmChangedTime and alarmClearedTime parameters in the relevant notifyNew/Changed/ClearedAlarm of this significant alarm. + +The third element (subSection titled: Relation to Log and AlarmList) specifies which alarms shall enter into Log of LogIRP and AlarmList of AlarmIRP. + +Each of the following subsections defines a Rule using the three-element description outlined above. + +For each Rule, illustration samples, using symbols shown below, are given (titled: Samples). The thick horizontal line indicates a time-line. The dotted double-arrow line indicates a time parameter, if applicable. The "?" box indicates the alarm under investigation. The left-edge of a box corresponds to the alarmRaisedTime while the right-edge corresponds to the alarmClearedTime. So, the horizontal span of a box indicates the alarm active time span. + +![Figure A.1-1: Sample diagram notations. A horizontal line with an arrow pointing right, labeled 't' at the end, represents a time-line. Above the line, there is a shaded rectangular box with a question mark '?' inside. The left edge of the box is aligned with a vertical dotted line, and the right edge is aligned with another vertical dotted line.](1320668e9151c5144f7e3696ae57e07f_img.jpg) + +Figure A.1-1: Sample diagram notations. A horizontal line with an arrow pointing right, labeled 't' at the end, represents a time-line. Above the line, there is a shaded rectangular box with a question mark '?' inside. The left edge of the box is aligned with a vertical dotted line, and the right edge is aligned with another vertical dotted line. + +**Figure A.1-1: Sample diagram notations** + +Sometimes, a shaded box is drawn below the time line as below. Such shaded box indicates the identification of a significant alarm (to be reported alarm). + +The left-edge of the box indicates the time when the corresponding alarm notification is sent out. This emission time is not necessarily identical to the alarmRaised/ChangedTime within the alarm notification. + +The right-edge of a box indicates the time when the corresponding alarm clearing notification is sent out. This emission time is not necessarily identical to the alarmClearedTime within the alarm notification. + +![A diagram showing a horizontal timeline labeled 't' at the right end. A rectangular box is centered on the timeline, with its top half being light gray and containing a question mark '?', and its bottom half being dark gray.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +A horizontal timeline with an arrow pointing to the right, labeled with the letter 't' at its end. A rectangular box is positioned such that the timeline passes through its center. The top half of the box is light gray and contains a question mark '?'. The bottom half of the box is dark gray. + +A diagram showing a horizontal timeline labeled 't' at the right end. A rectangular box is centered on the timeline, with its top half being light gray and containing a question mark '?', and its bottom half being dark gray. + +**Figure A.1-2: Sample diagram notations** + +For each Rule, use cases are given (subSection titled: Example for Use cases). + +For some Rules exception handling is defined (subSection titled: Exception Handling). + +## A.2 AAM Rules + +### A.2.1 Threshold Rule + +#### A.2.1.1 Parameters + +This Rule has three parameters, namely, the `alarmOccurenceThreshold` (called N here), the `slidingTimeWindow` (called T here) and `filter`. + +#### A.2.1.2 Criterion to determine alike alarm + +The `filter` parameter carries values for `objectInstance`, `alarmType`, `perceivedSeverity`, `probableCause` and `specificProblem`. If the alarm under investigation (e.g. the box with a '?' in the sample below) carries the same values, then it is considered 'alike' otherwise, "not-alike". + +#### A.2.1.3 Treatment of alike alarm + +Starting value for Lower Edge of Time Window is the activation time of the threshold rule. + +Test an alike alarm. + +When a new alarm matches the filter, then Lower and Upper Edge of Time Window and count are newly determined: Upper Edge of Time Window becomes the time of the new alarm. + +Lower Edge of Time Window becomes either the time of the current Lower Edge of Time Window or the time of the new alarm minus the default size T of the time window, whichever of these two times is later. + +The count is the number of alarms between Lower and Upper Edge of Time Window (including the new alarm). If the count reaches the threshold N, then the alarm is considered as significant and the Lower Edge of Time Window becomes the time of the alarm. + +For a not reported alarm no `notifyClearedAlarm` shall be sent. + +`NotifyClearedAlarms` for alarms which were reported to the `IRPManager` before the activation of the threshold rule shall not be suppressed. + +Table A.2.1.3-1 shows the emission times of the various related to a significant alarm. + +**Table A.2.1.3-1: Significant alarm emission time for Threshold Rule** + +| Reported alarm types | Emission (to IRPManager) times of a reported alarm | +|---------------------------------|-------------------------------------------------------| +| notifyNewAlarm | Immediately after the alarmRaisedTime . | +| notifyChangedAlarm | Immediately after the alarmChangedTime . | +| notifyClearedAlarm | Immediately after the alarmClearedTime | + +Table A.2.1.3-2 shows the time related parameters in significant alarm. + +**Table A.2.1.3-2: Significant alarm time parameters for Threshold Rule** + +| Parameters of the Reported alarm | Parameter values | +|----------------------------------|------------------------------------------------| +| alarmRaisedTime | Same value as that carried in the alike alarm. | +| alarmChangedTime | Same value as that carried in the alike alarm. | +| notifyClearedTime | Same value as that carried in the alike alarm. | +| alarmId | Same value as that carried in the alike alarm. | + +#### A.2.1.4 Relation to Log and AlarmList + +The alike alarms enter the Log. The significant alarms enter the AlarmList. + +#### A.2.1.5 Samples + +![Timeline diagram for Figure A.2.1.5-1 showing two alarms within a threshold time T, labeled N=3.](bd4617f25d15430eb78c2d6d75a99dde_img.jpg) + +A horizontal timeline labeled 't' at the right end. A dotted double-headed arrow labeled 'T' spans a portion of the timeline. Below the timeline, there are two gray rectangular boxes. The first box is solid gray. The second box, located to the right of the first, contains a question mark '?' and is partially cut off by the end of the timeline. + +Timeline diagram for Figure A.2.1.5-1 showing two alarms within a threshold time T, labeled N=3. + +Figure A.2.1.5-1: Threshold Rule illustrations – insignificant alarm + +![Timeline diagram for Figure A.2.1.5-2 showing three alarms within a threshold time T, labeled N=3.](47e75dc9e83054b2dac3df8bf3e57019_img.jpg) + +A horizontal timeline labeled 't' at the right end. A dotted double-headed arrow labeled 'T' spans a portion of the timeline. Below the timeline, there are three gray rectangular boxes. The first two are solid gray and located to the left. The third box, located to the right, contains a question mark '?' and is partially cut off by the end of the timeline. + +Timeline diagram for Figure A.2.1.5-2 showing three alarms within a threshold time T, labeled N=3. + +Figure A.2.1.5-2: Threshold Rule illustrations – insignificant alarm + +![Timeline diagram for Figure A.2.1.5-3 showing three alarms within a threshold time T, labeled N=3, where the third alarm is significant.](ec42effecdc5bce7bb2bf7a96c954845_img.jpg) + +A horizontal timeline labeled 't' at the right end. A dotted double-headed arrow labeled 'T' spans a portion of the timeline. Below the timeline, there are three gray rectangular boxes. The first two are solid gray and located to the left. The third box, located to the right, contains a question mark '?' and is partially cut off by the end of the timeline. This third box is shaded darker gray than the first two, indicating it is a significant alarm. + +Timeline diagram for Figure A.2.1.5-3 showing three alarms within a threshold time T, labeled N=3, where the third alarm is significant. + +Figure A.2.1.5-3: Threshold Rule illustrations – significant alarm + +#### A.2.1.6 Example for Use cases + +The thresholdRule can be used to screen out alarms which are only important if they appear repeatedly, e.g. if an alarm which is self-healing comes back again and again, + +### A.2.2 Transient Rule + +#### A.2.2.1 Parameters + +This Rule has two parameters, namely, the minutesAtLeastActive (called T here) and filter. + +#### A.2.2.2 Criterion to determine alike alarm + +The filter parameter carries values for objectInstance, alarmType, perceivedSeverity, probableCause and specificProblem. If the alarm under investigation (e.g. the box with a '?' in the sample below) carries the identified parameters and having the same values, then it is considered 'alike' otherwise, "not-alike". + +#### A.2.2.3 Treatment of alike alarm + +Take an alike alarm. If it's period is smaller than T, then it is an insignificant alarm; otherwise, it is a significant alarm. For a not reported alarm no notifyClearedAlarm shall be sent. + +NotifyClearedAlarms for alarms which were reported to the IRPManager before the activation of the transientRule shall not be suppressed. + +Table A.2.2.3-1 shows the emission times of the various related to significant alarm. + +**Table A.2.2.3-1: Significant alarm emission time re: Transient Rule** + +| Reported alarm type | Emission (to IRPManager) times of an Reported alarm | +|---------------------|-----------------------------------------------------| +| notifyNewAlarm | Immediately after the alarmRaisedTime plus T. | +| notifyChangedAlarm | Immediately after the alarmChangedTime plus T. | +| notifyClearedAlarm | Immediately after the alarmClearedTime | + +Table A.2.2.3-2 shows the time related parameters in significant alarm. + +**Table A.2.2.3-2: Significant alarm time parameters re: Transient Rule** + +| Parameters of the Reported alarm | Parameter values | +|----------------------------------|------------------------------------------------| +| alarmRaisedTime | Same value as that carried in the alike alarm. | +| alarmChangedTime | Same value as that carried in the alike alarm. | +| notifyClearedTime | Same value as that carried in the alike alarm | +| alarmId | Same value as that carried in the alike alarm. | + +#### A.2.2.4 Relation to Log and AlarmList + +The alike alarms enter the Log. The significant alarms enter the AlarmList. + +#### A.2.2.5 Samples + +Here are two samples. One is a not-to-be reported alarm while the other is a significant alarm. + +![Diagram of an insignificant alarm. A horizontal timeline labeled 't' has a light gray rectangular box with a question mark '?' on it. Above the box, a dotted double-headed arrow labeled 'T' indicates a duration that is shorter than the box's length. The label 'N=3' is to the left of the timeline.](65f66758012e229247953202e8adf35d_img.jpg) + +N=3 + +Diagram of an insignificant alarm. A horizontal timeline labeled 't' has a light gray rectangular box with a question mark '?' on it. Above the box, a dotted double-headed arrow labeled 'T' indicates a duration that is shorter than the box's length. The label 'N=3' is to the left of the timeline. + +Figure A.2.2.5-1: TransientRule Illustrations – insignificant alarm + +![Diagram of a significant alarm. A horizontal timeline labeled 't' has a light gray rectangular box with a question mark '?' on it. Above the box, a dotted double-headed arrow labeled 'T' indicates a duration that is shorter than the box's length. The box extends beyond the end of the timeline, and a dark gray rectangular box is shown below the timeline at the end, partially overlapping the light gray box. The label 'N=3' is to the left of the timeline.](d369dc114803a761d452c13ee58ed579_img.jpg) + +N=3 + +Diagram of a significant alarm. A horizontal timeline labeled 't' has a light gray rectangular box with a question mark '?' on it. Above the box, a dotted double-headed arrow labeled 'T' indicates a duration that is shorter than the box's length. The box extends beyond the end of the timeline, and a dark gray rectangular box is shown below the timeline at the end, partially overlapping the light gray box. The label 'N=3' is to the left of the timeline. + +Figure A.2.2.5-2: TransientRule Illustrations – significant alarm + +#### A.2.2.6 Example for Use cases + +The transientRule can be used to screen out alarms which usually are of temporarily nature. + +### A.2.3 Toggle Rule + +#### A.2.3.1 Parameters + +This Rule has 4 parameters, namely, the filter, the alarmOccurenceThreshold (called N here), the slidingTimeWindowTogglingStarted (called T1 here) and slidingTimeWIndowTogglingSettled (called T2 here). + +#### A.2.3.2 Criterion to determine alike alarm + +The filter parameter carries values for objectInstance, alarmType, perceivedSeverity, probableCause and specificProblem. If the alarm under investigation (e.g. the box with a “?” in the sample below) carries the identified parameters and having the same values, then it is considered ‘alike’ otherwise, “not-alike”. + +#### A.2.3.3 Treatment of alike alarm + +##### 1. Starting values: + +Starting value for Lower Edges of Time Windows for Toggling Started/Settled is the activation time of the toggle rule. Starting value for the count is zero. + +At the beginning all alarms are "non-toggling" + +##### 2. To do when alike alarm was identified + +When a notifyNew/Changed/ClearedAlarm event matches the filter, then Lower and Upper Edge of the Time Window TogglingStarted/Settled and count are newly determined: + +###### 2.1. Determine Time Window TogglingStarted + +Upper Edge of Time Window TogglingStarted becomes the time of the event. + +Lower Edge of Time Window TogglingStarted becomes the time of the event minus the size T1 of the time window. + +##### 2.2. Determination of "toggling" (via count) + +The count is the number of alike alarms between Lower and Upper Edge of Time Window TogglingStarted (including the new alarm). + +If the count is above or equal to the threshold N and the event was a notifyNewAlarm and the alarm was "non-toggling", then the notifyNewAlarm is sent and the alarm is considered as "toggling", with the consequence that further alike notifyNew/Changed/Alarm events are regarded as not significant, until the alarm is considered as "non-toggling" again. + +##### 2.3. Determine Time Window TogglingSettled + +If the alarm is "non-toggling", then there is no need to determine Upper and Lower Edge of Time Window TogglingSettled. + +If the alarm is "toggling", then: + +Upper Edge of Time Window TogglingSettled becomes the time of the new event plus the size T2 of the Time Window TogglingSettled . + +Lower Edge of Time Window TogglingSettled becomes the time of the new alarm . + +##### 3. Return to non-toggling + +If the time reaches the Upper Edge of Time Window TogglingSettled, then the alarm is considered as "non-toggling", i.e. alike alarms are regarded as significant. + +If the last event was a notifyChanged/ClearedAlarm, then the change to "non-toggling" triggers the emission of the related notification. + +Table A.2.3.3-1 shows the emission times of the various related to significant alarm. + +**Table A.2.3.3-1: Significant alarm emission time re: Toggle Rule** + +| Reported alarm types | Emission (to IRPManager) times of an Reported alarm | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifyNewAlarm | Immediately after the alarmRaisedTime | +| notifyChangedAlarm | Immediately after the alarmChangedTime [Remark: If the alarm is toggling state, then the notifyChangeAlarm is dropped (not significant).] | +| notifyClearedAlarm | Immediately after the alarmClearedTime+T2 of the last alike alarm , if alarmClearedTime is earlier than alarmRaisedTime+T2
or
immediately after the alarmClearedTime of the last alike alarm, if this time is later than or equal to alarmRaisedTime+T2 | + +Table A.2.3.3-2 shows the time related parameters in significant alarm. + +**Table A.2.3.3-2: Significant alarm time parameters re: Toggle Rule** + +| Parameters of the Reported alarm | Parameter values | +|----------------------------------|---------------------------------------------------------------| +| alarmRaisedTime | Same value as that carried in the alike alarm. | +| alarmChangedTime | Same value as that carried in the alike alarm. | +| notifyClearedTime | Same value as that carried in the last alike alarm. | +| alarmId | Same value as that carried by the first member of a sequence. | + +#### A.2.3.4 Relation to Log and AlarmList + +The alike alarms enter the Log. The significant alarms enter the AlarmList. + +#### A.2.3.5 Samples + +The samples below use N=3. + +![Figure A.2.3.5-1: Toggle Rule illustration 1. A timeline diagram showing alarm states over time 't'. A horizontal axis represents time. Above the axis, three boxes represent alarm states. The first two are light gray, and the third is white with a question mark. Below the axis, corresponding gray rectangles represent the alarm's presence in the AlarmList. The first two are short, and the third is longer. Above the first two boxes, a double-headed arrow labeled 'T 1' indicates a time interval. Above the third box, a double-headed arrow labeled 'T 2' indicates another time interval. To the left of the first box, a double-headed arrow labeled 'N=3' indicates a duration.](c8e5b3ef81948bb13d5c6c3c326799ea_img.jpg) + +Figure A.2.3.5-1: Toggle Rule illustration 1. A timeline diagram showing alarm states over time 't'. A horizontal axis represents time. Above the axis, three boxes represent alarm states. The first two are light gray, and the third is white with a question mark. Below the axis, corresponding gray rectangles represent the alarm's presence in the AlarmList. The first two are short, and the third is longer. Above the first two boxes, a double-headed arrow labeled 'T 1' indicates a time interval. Above the third box, a double-headed arrow labeled 'T 2' indicates another time interval. To the left of the first box, a double-headed arrow labeled 'N=3' indicates a duration. + +**Figure A.2.3.5-1: Toggle Rule illustration 1** + +![Timeline diagram for Figure A.2.3.5-2 showing alarm states over time t. It includes intervals T1 and T2, and a question mark in the fifth time slot.](c17eaf807acd5faec68da19dd16929be_img.jpg) + +This diagram illustrates a timeline for alarm states over time $t$ . A horizontal axis represents time, with a vertical line marking the start. Above the axis, a dotted double-headed arrow labeled $T1$ spans the first two time slots. Above the axis, another dotted double-headed arrow labeled $T2$ spans the third and fourth time slots. The label $N=3$ is positioned to the left of the first time slot. The timeline is divided into five slots by vertical lines. The first two slots contain light gray rectangles above the axis and dark gray rectangles below. The third and fourth slots contain only dark gray rectangles below the axis. The fifth slot contains a light gray rectangle above the axis with a question mark $?$ inside, and a dark gray rectangle below the axis. + +Timeline diagram for Figure A.2.3.5-2 showing alarm states over time t. It includes intervals T1 and T2, and a question mark in the fifth time slot. + +Figure A.2.3.5-2: Toggle Rule illustration 2 + +![Timeline diagram for Figure A.2.3.5-3 showing alarm states over time t. It includes intervals T1 and T2, and a question mark in the fifth time slot.](48a4d999034fb203698ddc187c259679_img.jpg) + +This diagram illustrates a timeline for alarm states over time $t$ . A horizontal axis represents time, with a vertical line marking the start. Above the axis, a dotted double-headed arrow labeled $T1$ spans the first two time slots. Above the axis, another dotted double-headed arrow labeled $T2$ spans the third and fourth time slots. The label $N=3$ is positioned to the left of the first time slot. The timeline is divided into five slots by vertical lines. The first two slots contain light gray rectangles above the axis and dark gray rectangles below. The third and fourth slots contain only light gray rectangles above the axis. The fifth slot contains a light gray rectangle above the axis with a question mark $?$ inside, and a dark gray rectangle below the axis. + +Timeline diagram for Figure A.2.3.5-3 showing alarm states over time t. It includes intervals T1 and T2, and a question mark in the fifth time slot. + +Figure A.2.3.5-3: Toggle Rule illustration 3 + +![Timeline diagram for Figure A.2.3.5-4 showing alarm states over time t. It includes an interval T1 and a question mark in the first time slot.](f880daa1cde4b71fcbaff2df81803a65_img.jpg) + +This diagram illustrates a timeline for alarm states over time $t$ . A horizontal axis represents time, with a vertical line marking the start. Above the axis, a dotted double-headed arrow labeled $T1$ spans the first time slot. The label $N=3$ is positioned to the left of the first time slot. The timeline is divided into two slots by a vertical line. The first slot contains a light gray rectangle above the axis with a question mark $?$ inside, and a dark gray rectangle below the axis. The second slot contains only a dark gray rectangle below the axis. + +Timeline diagram for Figure A.2.3.5-4 showing alarm states over time t. It includes an interval T1 and a question mark in the first time slot. + +Figure A.2.3.5-4: Toggle Rule illustration 4 + +#### A.2.3.6 Example for Use cases + +The `toggleRule` can be used to take some burden from alarm management for cases where an alarm comes and goes back and forth, e.g. because of some entity is in a swinging state. + +#### A.2.3.7 Exception Handling + +The Toggle Rule can potentially group multiple alike alarms together to form one significant alarm. If the process executing the Rule misses the alarm clearing time of one member of a group, then this can have the following consequences: + +If a clearing of one of the alike alarms during the toggling state is missed (green box in Figure A.2.3.7-1), then the significant alarm would also not be cleared (pink box continuing the dark grey in the same figure). This can be avoided if the filter is set in a way that only alarms of one instance will pass it and if always the latest `notifyClearedAlarms` triggers the start of T2. + +![Figure A.2.3.7-1: Exception handling example. The diagram shows a timeline with two horizontal bars. The top bar is green and represents the state of a significant alarm. The bottom bar is grey and represents the state of individual alarms. A dashed double-headed arrow labeled 'N=3' spans the first three grey boxes. A dashed double-headed arrow labeled 'T 1' spans the first two grey boxes. A red arrow labeled 'Missed notifyClearedAlarm' points to a green box in the top bar. A dashed double-headed arrow labeled 'T 2' spans the remaining part of the top bar. A pink box is at the end of the bottom bar, continuing the dark grey state. A question mark is inside a green box in the top bar. A horizontal arrow labeled 't' points to the right at the end of the bottom bar.](088921fa3f5a44c8551815122517eefd_img.jpg) + +Figure A.2.3.7-1: Exception handling example. The diagram shows a timeline with two horizontal bars. The top bar is green and represents the state of a significant alarm. The bottom bar is grey and represents the state of individual alarms. A dashed double-headed arrow labeled 'N=3' spans the first three grey boxes. A dashed double-headed arrow labeled 'T 1' spans the first two grey boxes. A red arrow labeled 'Missed notifyClearedAlarm' points to a green box in the top bar. A dashed double-headed arrow labeled 'T 2' spans the remaining part of the top bar. A pink box is at the end of the bottom bar, continuing the dark grey state. A question mark is inside a green box in the top bar. A horizontal arrow labeled 't' points to the right at the end of the bottom bar. + +Figure A.2.3.7-1: Exception handling example + +### A.2.4 Definition of vendor specific rule + +It is possible to implement vendor specific `AAMRules`. No specific definitions are supplied here. + +## A.3 Relation of Rule and Notification filter + +This clause illustrates the relation between the AAM capabilities and the NotificationIRP and AlarmIRP. + +The following diagram illustrates the case when AAM capabilities are not deployed. The "1, 2.. 6" indicates 6 alarms. They will be logged and they would appear in the AlarmList. The NotificationIRP supported a filter F1. The IRPManager, in this case, receives "1, 3" where '2, 4, 5, 6' were discarded because of Notification filter F1 is in effect. + +![Diagram showing alarm flow without AAM capabilities. AlarmIRP receives 1,2,3,4,5,6 from an external source and sends the same to NotificationIRP. NotificationIRP applies filter F1 and sends only 1,3 upwards. Below, a 'Log' box contains 1,2,3,4,5,6 and an 'AlarmList' box contains 1,2,3,4,5,6.](705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg) + +The diagram illustrates the flow of alarms when AAM capabilities are not deployed. An external source provides alarms "1,2,3,4,5,6" to the AlarmIRP. The AlarmIRP then sends these alarms to the NotificationIRP. The NotificationIRP, which supports filter F1, filters the alarms and sends only "1,3" upwards. Below the NotificationIRP, a 'Log' box contains the full list "1,2,3,4,5,6", and an 'AlarmList' box also contains the full list "1,2,3,4,5,6". + +Diagram showing alarm flow without AAM capabilities. AlarmIRP receives 1,2,3,4,5,6 from an external source and sends the same to NotificationIRP. NotificationIRP applies filter F1 and sends only 1,3 upwards. Below, a 'Log' box contains 1,2,3,4,5,6 and an 'AlarmList' box contains 1,2,3,4,5,6. + +Figure A.3-1: Deployment without AAM capabilities + +The following diagram illustrates the case when AAM capabilities are deployed. The "1, 2.. 6" indicates 6 alarms. They will be logged. Because of AAMRule R1 is in effect, the "1,2..6" result in two significant alarms, A and B. The A and B will appear in AlarmList. They will also be broadcasted to IRPManagers subject to NotificationIRP filter in effect. In the case below, the IRPManager would receive only A because Notification IRP filter F2 is in effect. + +![Diagram showing alarm flow with AAM capabilities. AlarmIRP receives 1,2,3,4,5,6 and passes them through AAMIRP with rule R1, resulting in alarms A and B. AAMIRP sends A,B to NotificationIRP. NotificationIRP applies filter F2 and sends only A upwards. Below, a 'Log' box contains 1,2,3,4,5,6 and an 'AlarmList' box contains A,B.](9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg) + +The diagram illustrates the flow of alarms when AAM capabilities are deployed. An external source provides alarms "1,2,3,4,5,6" to the AlarmIRP. The AlarmIRP passes these alarms through the AAMIRP, which applies rule R1, resulting in two significant alarms, A and B. The AAMIRP then sends these alarms (A,B) to the NotificationIRP. The NotificationIRP, which supports filter F2, filters the alarms and sends only "A" upwards. Below the NotificationIRP, a 'Log' box contains the full list "1,2,3,4,5,6", and an 'AlarmList' box contains the significant alarms "A,B". + +Diagram showing alarm flow with AAM capabilities. AlarmIRP receives 1,2,3,4,5,6 and passes them through AAMIRP with rule R1, resulting in alarms A and B. AAMIRP sends A,B to NotificationIRP. NotificationIRP applies filter F2 and sends only A upwards. Below, a 'Log' box contains 1,2,3,4,5,6 and an 'AlarmList' box contains A,B. + +Figure A.3-2: Deployment with AAM capabilities + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|------|-----|--------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| Sep 2007 | SA 37 | SP-070616 | -- | -- | Submitted to SA#37 for Information | -- | 1.0.0 | | +| Mar 2008 | SA 39 | SP-080072 | -- | -- | Submitted to SA#39 for Approval | -- | 2.0.0 | 8.0.0 | +| Jun 2008 | SA 40 | SP-080329 | 0001 | -- | Clarify the assumed scenarios for AAM rules | F | 8.0.0 | 8.1.0 | +| Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.1.0 | 9.0.0 | +| Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.0 | 10.0.0 | +| Sep-2012 | SA_57 | SP-120645 | 0005 | 1 | Clean-up of AAM IRP Information Service | D | 10.0.0 | 11.0.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.0.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 | +| 2022-03 | - | - | - | - | - | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-04 | - | - | - | - | - | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/32_series/32140/18442e4e239480f0c3c95b547aa8fde2_img.jpg b/marked/Rel-18/32_series/32140/18442e4e239480f0c3c95b547aa8fde2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1d48cb47dcf85bda1cea2100d0a2eb37e6792184 --- /dev/null +++ b/marked/Rel-18/32_series/32140/18442e4e239480f0c3c95b547aa8fde2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:13cfbe3a91fcdfa8291cacada063abbbfe2fb7391f694bcc19c3c3b1abd36c02 +size 81681 diff --git a/marked/Rel-18/32_series/32140/21ad58fee90f2be50708ff541d225507_img.jpg b/marked/Rel-18/32_series/32140/21ad58fee90f2be50708ff541d225507_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5287974d552aa986c66b33094702da7df32f11da --- /dev/null +++ b/marked/Rel-18/32_series/32140/21ad58fee90f2be50708ff541d225507_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e33381dc6c7c78b2fac03cdadafa894f3cc167035c51a5b7fae8d759ecc51481 +size 116175 diff --git a/marked/Rel-18/32_series/32140/3da1a07cb87051bf616c9876db958cf0_img.jpg b/marked/Rel-18/32_series/32140/3da1a07cb87051bf616c9876db958cf0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b57cb29b9a8a290ca27e4ba8e462a55de5d560b --- /dev/null +++ b/marked/Rel-18/32_series/32140/3da1a07cb87051bf616c9876db958cf0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e03c8ac7ae43547e42f00c131e0826f5926c75a992d428aea4d031b5a6ad5570 +size 69120 diff --git a/marked/Rel-18/32_series/32140/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32140/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b5eef52bd5febdd311709f2f538ca9c6cea1c447 --- /dev/null +++ b/marked/Rel-18/32_series/32140/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:446754ca0bb17b4a2a0587f9d84b96c00ae0c9961ee7235e36de0e0226045679 +size 9370 diff --git a/marked/Rel-18/32_series/32140/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32140/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6db162093ca75d99f9e213a8b578bede0a25f7eb --- /dev/null +++ b/marked/Rel-18/32_series/32140/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b0684f8f32e9e7c579bbf379647432694f54bb26971bf296194531e5b26e84f +size 5958 diff --git a/marked/Rel-18/32_series/32140/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg b/marked/Rel-18/32_series/32140/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2fda379b70db8c8a249258ee374e041c85315724 --- /dev/null +++ b/marked/Rel-18/32_series/32140/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcc73935dafc67af79232dcce61d1e9de4edd4511a89a450de862bdb4841f841 +size 35748 diff --git a/marked/Rel-18/32_series/32140/86b4670fc1a5a694821ee92b99c1209a_img.jpg b/marked/Rel-18/32_series/32140/86b4670fc1a5a694821ee92b99c1209a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..67556d2c299d9fb5b0f6ff9ac346bdaa4be4e8a8 --- /dev/null +++ b/marked/Rel-18/32_series/32140/86b4670fc1a5a694821ee92b99c1209a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:878071350c48478b7ee08b1a90e342493da93b459ae249931755615e94e17569 +size 63874 diff --git a/marked/Rel-18/32_series/32140/bd671b21db63e6fdb2196e9b18502aac_img.jpg b/marked/Rel-18/32_series/32140/bd671b21db63e6fdb2196e9b18502aac_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8def0a5ffcc4d97ad09d84b29370fe46558fde23 --- /dev/null +++ b/marked/Rel-18/32_series/32140/bd671b21db63e6fdb2196e9b18502aac_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c125cef3a5b4675c949e1405c63f4b373c452ef8d6032d99f158d80007947955 +size 74283 diff --git a/marked/Rel-18/32_series/32140/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg b/marked/Rel-18/32_series/32140/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..035f5a4f59e3f661c75b4f690c40a072da49df87 --- /dev/null +++ b/marked/Rel-18/32_series/32140/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1b1171c8e217ed08eb907d1a28b51b966081dee03dd29bf3220dcf155ba1f89 +size 31752 diff --git a/marked/Rel-18/32_series/32140/raw.md b/marked/Rel-18/32_series/32140/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..07d841df30161c953a193f0283ef4b69d96f4c53 --- /dev/null +++ b/marked/Rel-18/32_series/32140/raw.md @@ -0,0 +1,971 @@ + + +# 3GPP TS 32.140 V18.0.0 (2024-04) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Subscription Management (SuM) requirements (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in small capital letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in small capital letters. + +3GPP logo + +## --- **Keywords** + +--- + +Subscription Management, Converged +Management, service + +## **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. + +© 2024, 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..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 4 General description ..... | 10 | +| 4.1 Subscription Management (SuM) concept..... | 10 | +| 4.2 Partnership with Enhanced Telecom Operations Map (eTOM)..... | 11 | +| 4.3 SuM operations viewpoint ..... | 11 | +| 4.3.1 Functional overview ..... | 13 | +| 4.4 Management of subscription profiles..... | 14 | +| 4.4.1 Requirements for subscription profile component management..... | 14 | +| 4.4.2 Requirements for network and terminal provisioning..... | 15 | +| 4.4.3 Profile management evolution..... | 16 | +| 4.5 SuM: relationship to Network Entities and other subsystems..... | 17 | +| 4.5.1 General ..... | 17 | +| 4.5.2 Void ..... | 18 | +| 5 SuM assumptions and methods..... | 19 | +| 5.1 Business model assumptions..... | 19 | +| 5.2 Network and control assumptions..... | 19 | +| 5.3 Use case method..... | 19 | +| 6 High-level requirements..... | 20 | +| 6.1 General ..... | 20 | +| 6.1.1 Pre-requisites for service ..... | 20 | +| 6.2 Feature requirements..... | 21 | +| 6.2.1 Requirements on HSS/HLR ..... | 21 | +| 6.2.1.1 PS domain..... | 21 | +| 6.2.1.2 CS domain ..... | 21 | +| 6.2.1.3 IM CN Sub-system (IMS) ..... | 21 | +| 6.2.1.4 Authentication Center (AuC) ..... | 21 | +| 6.2.1.5 Equipment Identity Register (EIR)..... | 21 | +| 6.3 Security..... | 22 | +| Annex A (informative): Business model..... | 23 | +| A.1 Processes..... | 23 | +| A.2 Assumptions concerning actors and roles..... | 24 | +| A.3 SuM scope from actor/role model..... | 25 | +| A.4 Business model requirements..... | 25 | +| Annex B (informative): Example use case ..... | 26 | +| B.1 Create a subscription for a new subscriber ..... | 27 | +| B.2 Modify subscription for an existing subscriber..... | 28 | +| B.3 Delete subscription from an existing subscriber..... | 29 | +| B.4 Get subscription details of an existing subscriber..... | 30 | +| B.5 Create a subscription profile for a new user ..... | 30 | + +| | | | +|-------------------------------|--------------------------------------------------------------------|-----------| +| B.6 | Modify a subscription for an existing user..... | 31 | +| B.7 | Delete a subscription from an existing user..... | 32 | +| B.8 | Get subscription details of an existing user ..... | 32 | +| B.9 | Add service ..... | 33 | +| B.10 | Modify service ..... | 34 | +| B.11 | Delete service..... | 35 | +| B.12 | Get service details ..... | 36 | +| B.13 | Create and activate prepaid subscription for a new subscriber..... | 37 | +| B.14 | Delete prepaid subscription..... | 38 | +| Annex C (informative): | Change history..... | 39 | + +# --- 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. + +## 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 a TS-family covering the 3rd 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 32.171: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements". + +TS 32.172: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". + +TS 32.176: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions". + +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". + +Subscription Management (SuM) is a feature which will develop over a number of 3GPP releases. It is intended to permit 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. These correspond to the 'Fulfilment' Process areas of the TeleManagement Forum Telecom Operations Map [3]. + +Within the current version of the present document this is limited to a single operator's network. + +SuM 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. + +In 2G solutions the main repository of the subscription information is in the Home Locations Register (HLR). However the management and administration interfaces for controlling this information is proprietary to each vendor. The use of proprietary interfaces is inconvenient for those Operators using multiple vendors' equipment since their provisioning systems have to accommodate multiple proprietary interfaces, which perform essentially identical functions. Moreover, it makes it more difficult to generate customer self care applications that allow subscribers to provision, and amend subscription data. + +The 3G environment requires more complex service delivery mechanisms than in 2G and SuM is no longer simply an internal matter for a single operator but a capability that is achieved by linking together features across multiple Service Providers and Operators Operations Support Systems (OSS). Historically, the services provided by Operators have been defined within standards groups such as ETSI or 3GPP. With the advent of Open Services Access (OSA) being adopted by 3GPP the User Service Definitions will be replaced by Service Capabilities traded amongst Service Providers and Network Operators. This will allow Operators and Service Providers to define customized service environments that roam with users as they move amongst networks - this is the Virtual Home Environment (VHE) 3GPP TR 22.121 [9]. This customized service environment means that subscription information is held in a number of locations including the Home Network, the Visited Network, the User Equipment, Application VASP Equipment (e.g. servers accessed by the subscriber for content and information based services) and the Operations Systems of the Service Providers, and Operators supporting the subscriber's service subscription. + +Service delivery and support across multiple vendors' solutions and organizations is a feature of other industries, and the solutions adopted are secure supply chain solutions based upon mainstream e-commerce principles, methods and technologies. + +Integration Reference Points (IRPs) are specified in separate TSs. + +# --- 1 Scope + +The present document defines the service requirements and high-level architecture for SuM, including Converged Management of fixed and mobile networks. + +SuM is expected evolve in stages over several releases of 3GPP specifications. + +The present document provides additional supporting material, which whilst not within the scope of this release, provides an insight towards the future evolution. This is in order that initial work may be done with an appreciation of the wider context expected in future releases of 3GPP specifications. + +SuM for 3GPP is primarily concerned with the ability to define subscription profiles and associate the profile with subscribers, users and services that are authorized by agreements. The subscription profile may be used in the process of configuring various network resources (access and core) to make the service a reality for the user. + +The management capabilities extend to the creation, modification, synchronization, and re application of subscription profiles. + +The present document is oriented towards a standardized interface into the Home Subscriber Server (HSS) in order that services can be provisioned and maintained. + +The present document includes information applicable to Network Operators, content providers, and terminal and network manufacturers. + +The present document contains the core requirements for SuM, which are sufficient to provide management services. + +The method by which applications subscribe to OSA is not within 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 23.002: "Network architecture". +- [3] GB910 Telecom Operations Map v 2.1 (TeleManagement Forum). +- [4] MWIF MTR-002 (Annex A): "Architecture requirements". +- [5] ebXML Transport Routing and Packaging Overview and Requirements 26th May 2000 v0-96. +- [6] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [7] 3GPP TS 23.008: "Organisation of subscriber data". +- [8] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [9] 3GPP TR 22.121: "Service aspects; The Virtual Home Environment; Stage 1". +- [10] 3GPP TS 29.198-03: "Open Service Access (OSA) Application Programming Interface (API); Part 3: Framework". + +| | | +|-------------|------------------------------------------------------------------------------------------------------------------------| +| [11] - [12] | Void | +| [13] | 3GPP TS 22.041: "Operator Determined Call Barring". | +| [14] | 3GPP TS 23.015: "Technical realisation of Operator Determined Barring (ODB)". | +| [15] | 3GPP TS 32.102: "Telecommunication management; Architecture". | +| [16] - [17] | Void | +| [18] | 3GPP TS 32.803: "Telecommunication management; Process guide; Use cases in Unified Modelling Language (UML)". | +| [19] | ITU-T Recommendation M.3050.1 (2004) Enhanced Telecom Operations Map (eTOM) – The business process framework. | +| [20] | ITU-T Recommendation M.3050.2 (2004) Enhanced Telecom Operations Map (eTOM) – Process decompositions and descriptions. | + +# --- 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: + +**actor:** entity, party, person or organization playing one or more roles. + +**Integration Reference Point (IRP):** See 3GPP TS 32.102 [15]. + +**Network Operator (NO):** See 3GPP TR 21.905 [1]. + +**organization:** 'legal entity' that may perform one or more 'business roles' when interacting with other organizations. + +**PLMN operator:** See 3GPP TR 21.905 [1]. + +**reseller Service Provider (SP):** actor that resells services provided and defined technically by another service provider. The reseller may re-brand the service or offer a modified tariff package to its customers. + +**retailer:** organization that sells 3GPP User Equipment (UE) and services to retail customers. + +**role:** defined by a set of properties or attributes that describe the capabilities of an entity that can be performed on behalf of other role(s). An activity performed by an actor. Each actor can play many roles. + +**service:** See 3GPP TR 21.905 [1]. + +**service integrator:** organization that takes a set of services from other providers and derives an end-to-end set of services. It has responsibility for the end to end service QoS to the customer. + +**Service Profile (SProf):** a service specific subscription profile component. + +**Service Provider (SP):** See 3GPP TR 21.905 [1]. + +**subscribed services profile:** contains identifications of subscribed services, their status and reference to service preferences; this is a component of the subscriber profile. + +**subscriber:** See 3GPP TR 21.905 [1]. + +**subscriber profile:** The set of data managed and stored by Subscription Management (SuM) for a subscriber for the management of associated users and subscribed services and the limits relative to their use. + +**subscription:** See 3GPP TR 21.905 [1]. + +**Subscription Management (SuM):** set of capabilities that allow Operators, Service Providers (SPs), and indirectly subscribers, to provision, control, monitor the subscription profile. + +**subscription profile:** The set of data managed and stored by network domains and subsystems for the operation and execution of the services provided to a specific user associated with a subscriber. + +**subscription profile component:** discrete subset of the subscription profile that may be stored or managed separately from other subsets e.g. components that may be stored in different domains, subsystems or replicated using different synchronization rules. + +**trusted third party:** organization that performs an agreed role on behalf of two or more other organizations (e.g. authentication, trust, market place services etc.). + +**user:** See 3GPP TR 21.905 [1]. + +**Value Added Service Provider (VASP):** See 3GPP TR21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|-------------------------------------------------------| +| 2G | Second Generation Mobile | +| 3G | Third Generation Mobile | +| API | Application Programming Interface | +| AuC | Authentication Center | +| B2B | Business to Business | +| CS | Circuit Switch | +| DDM | Data Definition Method | +| EIR | Equipment Identity Register | +| GTT | Global Text Telephony | +| HLR | Home Location Register | +| HSS | Home Subscriber Server | +| IMS | IP Multimedia Subsystem | +| IRP | Integration Reference Point (see 3GPP TS 32.102 [15]) | +| MMS | Multimedia Messaging Service | +| MWIF | Mobile Wireless Internet Forum | +| NPDB | Number Portability Data Base | +| OAM | Operations, Administration and Maintenance | +| OSA | Open Services Access | +| OSS | Operations Support System | +| PS | Packet Switch | +| QoS | Quality of Service | +| SP | Service Provider | +| SProf | Service Profile | +| SuM | Subscription Management | +| eTOM | enhanced Telecom Operations Map (TMF/ITU-T) | +| UICC | Universal Integrated Circuit Card | +| USIM | Universal Subscriber Identity Module | +| VASP | Value Added Service Provider | +| VHE | Virtual Home Environment | +| VPLMN | Visited Public Land Mobile Network | + +# 4 General description + +## 4.1 Subscription Management (SuM) concept + +The 3G environment requires more complex service delivery mechanisms than in 2G. The following drivers are leading to a need to standardize SuM Interfaces: + +- Use of different vendor's equipment for 2G/2.5G and 3G. +- The trend in 2/2.5G toward the support of Virtual Network Operators and Content Providers requiring standardized interfaces amongst them. + +Service delivery and support across multiple vendors' solutions and organizations is a feature of other industries, and the solutions are adopted are secure supply chain solutions based upon mainstream e-commerce principles, methods and technologies. + +SuM is an area of service operation management that permits Service Providers and Operators to provision services for a specific customer service subscription. + +Specific 3G areas that SuM requirements must address are: + +- Subscription information is distributed across in a number of locations including the Home Network, the Visited Network, the User Equipment, Application VASP equipment (e.g. servers accessed by the subscriber for content and information based services). +- SuM will allow Service Providers and Operators to provision, control and monitor the subscription information. +- SuM is not simply an internal matter for a single operator but a capability that is achieved by linking together features across multiple Operators' Operations Support Systems (OSSs). +- SuM will need to manage subscription information in e.g. the OSSs, HSS, UE, OSA, MMS and IMS subsystems. + +The conceptual model for SuM is illustrated in figure 1. + +![Figure 1: High level view of Subscription Management (SuM). The diagram shows a triangle of three entities: Customer Care Center (top), User / Subscriber (bottom left), and Subscription Profile (bottom right). The Customer Care Center is represented by a person icon and a green box. The User / Subscriber is represented by a person icon and an orange box. The Subscription Profile is represented by a light blue box. Arrows connect the Customer Care Center to both the User / Subscriber and the Subscription Profile. A double-headed arrow connects the User / Subscriber and the Subscription Profile.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +``` +graph TD; CCC[Customer Care Center] --> US[User / Subscriber]; CCC --> SP[Subscription Profile]; US <--> SP; +``` + +Figure 1: High level view of Subscription Management (SuM). The diagram shows a triangle of three entities: Customer Care Center (top), User / Subscriber (bottom left), and Subscription Profile (bottom right). The Customer Care Center is represented by a person icon and a green box. The User / Subscriber is represented by a person icon and an orange box. The Subscription Profile is represented by a light blue box. Arrows connect the Customer Care Center to both the User / Subscriber and the Subscription Profile. A double-headed arrow connects the User / Subscriber and the Subscription Profile. + +**Figure 1: High level view of Subscription Management (SuM)** + +SuM is concerned with provisioning the subscription profile throughout all the systems and trading partners needed to realize the customer service, SuM provides specifications that define the interfaces and the procedures that interconnect the three points of the SuM triangle: Customer Care Center, the User and the network (s) where the Subscription profile resides (such as HSS, USIM, etc.). + +## 4.2 Partnership with Enhanced Telecom Operations Map (eTOM) + +The Enhanced Telecom Operations Map as defined in ITU-T M.3050 [19] [20] provides a comprehensive framework for operating and running a network. + +SuM, in particular the configuration of resources, aligns with subset of the eTOM model in the area of fulfilment. + +**Table 1: Relationship between SuM and the eTOM model ITU-T M3050.2 [20]** + +| eTOM Fulfilment Processes | eTOM level 2 process | Applicable to SuM | eTOM level 3 processes applicable to this SuM release | +|-----------------------------|--------------------------------------|-------------------|-------------------------------------------------------| +| CRM Fulfilment | Order Handling | No | | +| | Marketing Fulfilment Response | No | | +| | Selling | No | | +| SM&O | Service Configuration and Activation | Yes | Implement, Configure & Activate Service | +| RM&O | Resource Provisioning | Yes | Configure & Activate Resource | +| S/P Relationship Management | S/P Requisition Management | No | | + +## 4.3 SuM operations viewpoint + +Figure 2 positions SuM from the viewpoint of operations management. + +![Figure 2: SuM context within operations management. The diagram shows three horizontal layers. The top layer is 'Service Management & Operations' (yellow box) containing 'Subscription Management' (green box) with icons for a person, a process (parallelogram), and a Subscription Profile Component (cylinder). The middle layer is 'Resource Management & Operations' (light blue box) containing icons for a process and a Subscription Profile Component. The bottom layer is 'Network Domains' (orange box) containing three cloud-like shapes, each with a process and a Subscription Profile Component. A legend at the bottom identifies the icons: a parallelogram for 'Process', a cylinder for 'Subscription Profile Component', and a rectangle for 'SuM Systems'.](18442e4e239480f0c3c95b547aa8fde2_img.jpg) + +Figure 2: SuM context within operations management. The diagram shows three horizontal layers. The top layer is 'Service Management & Operations' (yellow box) containing 'Subscription Management' (green box) with icons for a person, a process (parallelogram), and a Subscription Profile Component (cylinder). The middle layer is 'Resource Management & Operations' (light blue box) containing icons for a process and a Subscription Profile Component. The bottom layer is 'Network Domains' (orange box) containing three cloud-like shapes, each with a process and a Subscription Profile Component. A legend at the bottom identifies the icons: a parallelogram for 'Process', a cylinder for 'Subscription Profile Component', and a rectangle for 'SuM Systems'. + +**Figure 2: SuM context within operations management** + +SuM manages Subscriptions in the form of Subscription profile components. The subscription profile components may be distributed across Service Management & Operations (SM&O), Resource Management & Operations (RM&O) and Network domains in order to easily configure resources and support services at the Network Operations Management level. + +There may also be mappings of subscription profile components between the SM&O, RM&O and Network domains. In particular, such mapping may exist between a model of services and service parameters in the SM&O layer and the model of service parameters in the SuM NRM. Similarly, such mapping may also exists for identifiers and the concepts of user and subscriber as found in the SuM NRM to/from other representations of these concepts in the SM&O layer. These mappings are outside the scope of the SuM NRM. + +### 4.3.1 Functional overview + +As the telecommunications now entering into the 3G, more powerful terminal and access technology allows the telecommunications networks to offer new wireless Multimedia and Internet services. + +Accordingly, SuM is a telecommunications management framework that allows the Operators to leverage their network resources to: + +- Validate (register, authenticate, and authorise.) a request for service from a user; +- Collect, store, update, and distribute the Service Profile information for the user; +- Select the trusted network resources to manage access, distribution, and control of the profile data information for the user; and +- Direct the network resources to promptly deliver the service requested to the user according to said profile information. + +SuM fulfils the following essential 3G requirements: + +- The "**Device Diversity**" allows access to telecommunications networks by a variety of UEs and devices that are available for the user at the time. +- The "**Access Diversity**" allows the telecommunications networks to offer a variety of access network options such as UTRAN, GERAN, WLAN, etc. to the user. +- The "**Service Diversity**" allows the Telecommunications networks to provide a variety of services delivered to the user from third party application Service Providers (VASP) or from other telecommunications networks (VPLMN). + +## 4.4 Management of subscription profiles + +![Figure 3: Architecture for management of subscription profile components. The diagram shows the flow of subscription profile management. On the left, a 'Request for Service' box points to a 'Customer Care' and 'Service Registration/Management' box, which is part of a 'Service Portfolio'. This points to a box containing 'SProf Common Object' and 'SProf DDM', which then points to a 'Service Delivery' oval. Below the 'SProf Common Object' box is another box containing 'SProf Master', 'SProf Log', 'SProf Distribute', and 'SProf Backup'. This points to a 'SProf Store' box, which points to a 'SProf Access' box, which points to a 'SProf Download' box. A 'SProf ID' box points to the 'SProf Access' box.](bd671b21db63e6fdb2196e9b18502aac_img.jpg) + +``` + +graph LR + subgraph SP [Service Portfolio] + SC[Customer Care] + SRM[Service Registration/Management] + end + RS[Request for Service] --> SC + SC --> SCO[SProf Common Object] + SRM --> SCO + SCO --> SD((Service Delivery)) + SCO --> SD + subgraph SPM [Subscription Profile Management] + SM[SProf Master] + SL[SProf Log] + SDist[SProf Distribute] + SB[SProf Backup] + end + SM --> SS[SProf Store] + SL --> SS + SDist --> SS + SB --> SS + SS --> SA[SProf Access] + SA --> SDn[SProf Download] + SID[SProf ID] --> SA + +``` + +Figure 3: Architecture for management of subscription profile components. The diagram shows the flow of subscription profile management. On the left, a 'Request for Service' box points to a 'Customer Care' and 'Service Registration/Management' box, which is part of a 'Service Portfolio'. This points to a box containing 'SProf Common Object' and 'SProf DDM', which then points to a 'Service Delivery' oval. Below the 'SProf Common Object' box is another box containing 'SProf Master', 'SProf Log', 'SProf Distribute', and 'SProf Backup'. This points to a 'SProf Store' box, which points to a 'SProf Access' box, which points to a 'SProf Download' box. A 'SProf ID' box points to the 'SProf Access' box. + +Figure 3: Architecture for management of subscription profile components + +### 4.4.1 Requirements for subscription profile component management + +SuM does not extend to the management of services. + +However it is necessary to provide network entities with the subscription profile components needed for service fulfilment: + +1. Subscription profile management shall support the fulfilment of requests for service from users, application services, and user equipment. +2. Subscription profile management shall support requests for subscription creation, modification and deletion. These requests may originate from users, subscribers, Network Operators, and Service Providers. +3. The above requests may be associated with service entities such as the MMS, IMS etc. +4. It shall be possible to relate each request for service with the corresponding Service Profile (SProf) information +5. The subscription profile information shall be maintained in the HSS. +6. In order to fulfil services, subscription profile information shall be distributed among the various network entities. +7. A subscription profile log shall be created to track changes related to creation and modification of subscription profiles and subscription profile components. +8. A backup copy of the subscription profile shall be created. +9. Subscription profile information shall be secured by authorised access and control mechanisms. + +### 4.4.2 Requirements for network and terminal provisioning + +![Diagram of SuM network and service provisioning showing the hierarchy of profiles and their relationship to the operator's database management.](75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg) + +The diagram illustrates the logical structure of profiles in SuM network and service provisioning. At the top, a dashed box labeled **Logical Database** contains three stacked rectangular boxes: a yellow box labeled **Subscription Profile**, a purple box labeled **Service Profile**, and a green box labeled **Network Profile**. Below the **Network Profile** box, a downward-pointing arrow leads to a teal box labeled **Terminal Profile**. To the right of the **Logical Database** box is a grey rectangular box containing the text **Operator Network wide** and **Database Mgmt**. + +Diagram of SuM network and service provisioning showing the hierarchy of profiles and their relationship to the operator's database management. + +**Figure 4: SuM network and service provisioning** + +The following steps define a logical sequence of events required for granting a request for service. + +- a) A request for service is issued by a user (via the UE). +- b) Network receives the request for service and attempts to locate a subscriber ID. +- c) Once a subscriber ID is identified, it is authenticated if there has not already been an initial authentication. +- d) A request for service shall be denied if the subscriber cannot be identified and authenticated. +- e) For those requests for service that are authenticated, the corresponding subscription profile components are obtained if they have not already been obtained at initial authorization. +- f) The subscription profile component provides information on the services that are available to the subscriber and correlate the service request with a specific subscribed service. + +The service is properly set up according to the profile (e.g. QoS, etc.) in order to prepare for the fulfilment and delivery of the service. + +### 4.4.3 Profile management evolution + +For SuM stage 2 or 3, SP can expand from the current definition of subscriber data (e.g. 3GPP TS 23.008 [7]) when appropriate. + +Subscription profile supports: + +- Preference management; +- Service customization; +- Terminal management; +- Information sharing; +- Access permission via a unique key identifier. + +The profile data will be distributed (using the Service Profile download capability) to configure the necessary architectural entities (UE, Servers etc.). + +Subscription profile data needs to be consistently managed across all the entities within the network that use the profile. The data may be controlled from a central point, or be distributed, hence the logical database depicted in figure 4. The management capabilities relate to the definition, modification and synchronization of the data mainly in core network entities. This may extend to data needed in Terminal Devices, Network Elements, Core Network entities and Application Servers. + +## 4.5 SuM: relationship to Network Entities and other subsystems + +### 4.5.1 General + +The SuM Feature provides management functions for subsystems, domains and components some of which are defined in the 3GPP Network Architecture 3GPP TS 23.002 [2]. However the Network Architecture does not address the Mobile Equipment or the Open Services Architecture nor non 3GPP defined subsystems. Figure 5 shows this relationship with these entities, many of which are closely related to the Home Subscriber Server (HSS). + +![Figure 5: Examples of SuM relationships with Network Architecture. This diagram illustrates the central role of the Subscription Management Feature (SuM) in a telecommunications network. At the top, an 'Application User Account/Profile' is shown. Below it, a 'Customer Care Operations' entity (represented by a person at a computer) interacts with the 'Subscription Management Feature'. The SuM feature is part of a larger 'Service and Resource Management & Operations (SM&O and RM&O)' block, which also includes 'Other Features'. Arrows point from this block to 'To Network API Features' and 'To B2B Trading Partners'. The SuM feature connects to an 'AuC' (Authentication Centre), which is part of the 'HSS' (Home Subscriber Server). The HSS contains 'Subscription information' and 'Location information'. The HSS is connected to an 'EIR' (Equipment Identity Register) and a 'VLR' (Visitor Location Register). Below these, the diagram shows various network domains: 'CS Domain' (containing MSC Server and GMSC Server), 'PS Domain' (containing SGSN, GGSN, and EPC), 'IMS' (containing CSCF), and 'CAMEL' (containing gsmCSF). An 'Application Service' (e.g., GTTD, SMS Centre, Presence) and another 'Application User Account/Profile' are also connected to the SuM feature. An 'NPDB' (Number Portability Database) is shown on the right side, connected to the HSS.](21ad58fee90f2be50708ff541d225507_img.jpg) + +Figure 5: Examples of SuM relationships with Network Architecture. This diagram illustrates the central role of the Subscription Management Feature (SuM) in a telecommunications network. At the top, an 'Application User Account/Profile' is shown. Below it, a 'Customer Care Operations' entity (represented by a person at a computer) interacts with the 'Subscription Management Feature'. The SuM feature is part of a larger 'Service and Resource Management & Operations (SM&O and RM&O)' block, which also includes 'Other Features'. Arrows point from this block to 'To Network API Features' and 'To B2B Trading Partners'. The SuM feature connects to an 'AuC' (Authentication Centre), which is part of the 'HSS' (Home Subscriber Server). The HSS contains 'Subscription information' and 'Location information'. The HSS is connected to an 'EIR' (Equipment Identity Register) and a 'VLR' (Visitor Location Register). Below these, the diagram shows various network domains: 'CS Domain' (containing MSC Server and GMSC Server), 'PS Domain' (containing SGSN, GGSN, and EPC), 'IMS' (containing CSCF), and 'CAMEL' (containing gsmCSF). An 'Application Service' (e.g., GTTD, SMS Centre, Presence) and another 'Application User Account/Profile' are also connected to the SuM feature. An 'NPDB' (Number Portability Database) is shown on the right side, connected to the HSS. + +**Figure 5: Examples of SuM relationships with Network Architecture** + +Figure 5 is based upon entities identified in the 3GPP Network Architecture 3GPP TS 23.002 [2]. + +The Network Architecture identifies a number of entities that use subscription profile information for their operation. + +The SuM feature provisions and audits the subscription profile information (either directly, or indirectly): + +- **Core Network entities:** + - 1) Home Subscriber Server (HSS) including Home Location Register (HLR), Authentication Centre and HSS Logical functions; + - 2) Visitor Location Register (VLR); + - 3) Equipment Identity Register (EIR); + +- 4) SMS.- GMSC; +- 5) SMS Interworking MSC. + +#### **Circuit Switched Domain:** + +- 1) MSC Server; +- 2) Gateway MSC (GMSC). + +#### **User Equipment/Mobile Station:** + +Specific entities of the Mobile System as: + +- 1) IP Multimedia System (IMS); +- 2) CAMEL Entities; +- 3) Number Portability Database (NPDB); +- 4) Global Text Telephony (GTT) entities. + +SuM also provides capabilities to support B2B trading interfaces to other trading partners: VASP, Virtual mobile Operators etc. + +Figure 5 also implies a set of relationships from SuM to: + +- User Equipment Management that is assumed to configure and provision all aspects of the User Equipment and Terminals, including the possibility of configuring UICC/USIM profile information, using MeXe where appropriate. +- Application Service provided by third parties including trusted third parties that may configure some USIM via network interfaces, for example banks and other financial institutions. These services may also be provided by the Network Operator performing the role of Application Service provider. +- Network Service provided by Network Operators (e.g. SMS, presence). + +### 4.5.2 Void + +# --- 5 SuM assumptions and methods + +The following assumptions are made in developing the SuM requirements. + +## 5.1 Business model assumptions + +1. The provider of the service package to the subscriber may be different from either the Service Provider or the Network Operator. +2. The model shall allow for retailers, distributors and third parties that are independent of the Service Provider and the Network Operator. + +## 5.2 Network and control assumptions + +1. The invocation of a service feature in real time shall be the responsibility of the network and any associated control. + +## 5.3 Use case method + +Use cases are developed using the techniques defined in 3GPP TR 32.803 [18]. + +An illustrative set of use cases using the method can be found in annex B. + +# 6 High-level requirements + +## 6.1 General + +![Diagram illustrating the relationships between Users, Subscribers, Subscriptions, and Services. On the left, three 'User' boxes are stacked vertically within a green container. Dashed blue arrows point from these users to a stack of 'Subscriber' boxes (teal). From the front-most 'Subscriber' box, solid blue arrows point to three 'Subscription' boxes (blue). From each 'Subscription' box, a solid blue arrow points to a 'Service' box (pink). The 'Service' boxes are stacked vertically on the right side of the diagram.](3da1a07cb87051bf616c9876db958cf0_img.jpg) + +Diagram illustrating the relationships between Users, Subscribers, Subscriptions, and Services. On the left, three 'User' boxes are stacked vertically within a green container. Dashed blue arrows point from these users to a stack of 'Subscriber' boxes (teal). From the front-most 'Subscriber' box, solid blue arrows point to three 'Subscription' boxes (blue). From each 'Subscription' box, a solid blue arrow points to a 'Service' box (pink). The 'Service' boxes are stacked vertically on the right side of the diagram. + +**Figure 6: SuM Entities - Relations** + +Figure 7 shows the relationships between users, subscribers, subscriptions and services. + +According to the way in which Operators do business: + +- Each Operator has many subscribers; +- Each subscriber can have several users; and +- Users can request a service. The request will be granted if for the user, a contract for the requested service has been signed between the service provider and a subscriber. + +### 6.1.1 Pre-requisites for service + +These assertions address some of the operator's concerns, prior to granting a service request to a user: + +1. find a subscriber entity that can match with the user; +2. identify and verify the subscriber's subscription profile; and +3. ensure the request for service is consistent with the subscription profile. + +## 6.2 Feature requirements + +SuM shall provide: + +1. The management of the subscription profile information in the home PLMN. +2. It shall be possible to replicate and distribute the subscription profile components. + - Support for subscription profile information across administrative, network and systems domains (e.g. VLR in visited networks). +3. The control and modification of subscription profile information consistent with the customer care needs including self help, self diagnosis and fault diagnosis. + - SuM shall provide a process to support subscribers wishing to check their Subscription Configuration (e.g. support self care). + +### 6.2.1 Requirements on HSS/HLR + +The master database where subscription profile components are stored is in the HSS/HLR, which is used by the network for distribution and replication of this data in other subsystems such as the PS, CS and IM domains, CAMEL, etc. + +1. SuM shall allow for the creating, reading, updating and deleting of subscription profile data in the HSS/HLR. +2. SuM shall support the data described in 3GPP TS 23.008 [7]. + +#### 6.2.1.1 PS domain + +1. SuM shall manage subscription profile components within the HSS for the PS Domain. + +#### 6.2.1.2 CS domain + +1. SuM shall manage subscription profile components within the HSS for the CS Domain. + +#### 6.2.1.3 IM CN Sub-system (IMS) + +1. SuM shall manage subscription profile components within the HSS for the IMS defined in reference 3GPP TS 23.228 [8]. + +#### 6.2.1.4 Authentication Center (AuC) + +1. SuM shall be able to manage subscription profile components in the HSS for the Authentication Center. + +#### 6.2.1.5 Equipment Identity Register (EIR) + +1. SuM shall be able to manage relevant subscription profile components in the HSS for the EIR +2. SuM shall support Subscription Data defined in reference 3GPP TS 22.041 [13], 3GPP TS 23.015 [14]. + +## 6.3 Security + +1. Specific local, national, and regional security regulations shall be complied with. +2. SuM data shall be safeguarded against unapproved disclosure or usage. +3. SuM data shall be provided in a secure and reliable manner that ensures the information is neither lost nor corrupted. +4. Access to SuM data shall only be permitted in an authorised and secure manner +5. Secure mechanisms shall be available for the transfer of SuM data to, from or between authorised entities. +The secure mechanisms to be applied shall be appropriate to the level of confidentiality of the data, the endpoints of the transfer and the routes that are available for the transfer of the data. +6. Audit records should be maintained for all SuM transactions to facilitate resolution of security violations. + +# Annex A (informative): Business model + +## A.1 Processes + +Processes involved in SuM can be described by the e-Business Telecom Operations Map (TOM) version 2.1. It is the Fulfilment part that describes those processes. The present document mainly focus on the Development and Operations Process, Network and System Management Processes and on the Network Element Management process. + +The MWIF business model MTR-002 [4] shows an organizational model for Trading partners co-operating to provide wireless mobile services, the terms used in this example may not coincide exactly with those used in other parts of the present document, e.g. Subscriber and Customer are believed to be equivalent. + +![Figure A.1: Assumed Business Model diagram showing relationships between Subscriber, Service Provider, Content Provider, User, Network Operator, and Third Party Service Provider.](86b4670fc1a5a694821ee92b99c1209a_img.jpg) + +The diagram illustrates the Assumed Business Model with six entities arranged in a circular fashion: Subscriber (top-left), Service Provider (top), Content Provider (top-right), Third Party Service Provider (bottom-right), Network Operator (bottom), and User (bottom-left). The relationships are defined by three types of links: + +- Communications Connection (solid double-headed arrow):** Connects User and Network Operator, and Network Operator and Third Party Service Provider. +- Commercial Link (dashed double-headed arrow):** Connects Subscriber and Service Provider, Service Provider and Content Provider, Service Provider and Third Party Service Provider, and Service Provider and User. +- Logical Link (dotted double-headed arrow):** Connects Subscriber and User, User and Service Provider, User and Network Operator, and Content Provider and Third Party Service Provider. + +Figure A.1: Assumed Business Model diagram showing relationships between Subscriber, Service Provider, Content Provider, User, Network Operator, and Third Party Service Provider. + +**Figure A.1: Assumed Business Model** + +In this business model the Subscriber is a customer of the Service Provider (SP). + +Commercial agreements are set up and maintained between them for the provision of services from the SP to the User via the Network Operator. + +The Subscriber may have contracts with multiple SPs and maintains these on behalf of one or more users. + +The Subscriber informs the SP which services each user should have access to and may choose to set limits on how much a User can use a particular service. For instance the Subscriber may authorize \$x a day of video calls with a high QoS and unlimited video calls with a lower QoS. + +The SP must enter into contract(s) with one or more Network Operators in order to deliver services to Users. Other companies may wish to sell services without having a contract with a Network Operator. This can be achieved by adopting the role of Third Party Service Provider and selling service via the SP. Other Companies may wish to sell just content. This is made possible by developing a commercial relationship with either a SP or a Third Party Service Provider. + +It is important to note that Service Use, Customer Service Negotiation, etc are roles , and that one Actor may adopt more than one role. For instance an individual may adopt the roles of both Service Use and Customer Service Negotiation. A Company may adopt the roles of Network Operator, SP and Content Provider. + +A user initiates a service by requesting it from the Service Provider, not the Network Operator. On receipt of a service request the Service Provider uses Network Operators and Third Party Service Providers to service the request in the best way possible. In the example of the video call the Service Provider may choose to use different Network Operators for high and low QoS calls. + +Taking the VHE concept, where HE, HE-VASP are defined and VASP is used: + +- The roles Service Provider and Network Operator can be mapped to the actor HE (See 3GPP TS 22.121 [9]). +- The role Service Provider can be mapped to the actor VASP. +- The role Third Party Service Provider can be mapped to the actor HE-VASP, because they both provide services on behalf of an actor having the Service Provider role. + +The Subscriber-to-Service Provider relation (indicated as a Commercial Link between Service Provider and Subscriber) defines the agreements under which the Service Provider provides services to a Subscriber. The users associated to the Subscriber consume these services. (See Subscriber definition in 3GPP TR 21.905 [1].) + +There are also Business-to-Business relations in the picture, where several actors may be involved in the delivery of services. Examples of such are the Commercial Link between Service Provider and Third Party Service Provider, the Commercial Link between Third Party Service Provider and Content Provider and the Commercial Link between Service Provider and Network Operator. + +The present document has the focus on the Subscriber-Service Provider role relation. + +## --- A.2 Assumptions concerning actors and roles + +Below follows assumptions originated from figure A.1: + +- An actor taking the role as a Service Provider offers services to one or several Subscribers. +- An actor Network Operator can take the role as a Service Provider and provide access network services (e.g. PLMN services according to 3GPP TR 21.905 [1] definition) to one or several Subscribers. +- An actor Service Provider may fulfil his role and provide value added services to one or several Subscribers. He can do so by: + - A pure value added service offering, which may result in established B2B agreements with Network Operators. + - An aggregated offering of access network services (Network Operator role) and value added services (offering a home environment). +- An actor Service Provider may establish B2B agreements with Network Operators and become an MVNO. +- An actor Service Provider may have B2B agreements with one or several Content Providers, from which he can provide content based services. +- An actor Service Provider may have B2B agreements with one or several 3rd party Service Providers, from which he can package and provide services from. +- An actor 3rd party Service Provider may have B2B agreements with one or several Content Providers, which can provide content. +- An actor taking the role as a Service Provider may establish one or several subscriptions with a Subscriber. +- When, based on an agreement between a Subscriber and a Service Provider, an access to a provided service exists; it can be associated to a subscription. +- A User consumes services, where the user role in this context is defined by the service consumed. + +## --- A.3 SuM scope from actor/role model + +SuM is about managing subscriptions tied to one actor taking the Service Provider Role. Systems affected are those within the Service Provider domain (systems that a Service Provider controls and manages) and those systems outside that take part in the service delivery to the user of the service provided. The latter means: Actors having those systems have B2B agreements with a Service Provider for the purpose of delivering services (examples are: 3rd party Service Providers, Content Providers and Network Operators). + +## --- A.4 Business model requirements + +1. SuM feature shall support the distribution of SuM components across intra operator organizations and administrative domains to support industry business model. + +Annex A provides an example business model from MWIF MTR-002 [4]. + +2. SuM shall allow for the optional use of third parties to facilitate trading relationship between organizations. This requirement is needed for trusted third parties but not limited to trusted third parties + +# --- Annex B (informative): Example use case + +There are an expanding number of services that 3G can offer. The network and infrastructure resources that are needed to support the new services are complex, and require a systematic technique to consider the many factors involved. + +Use cases provide an iterative analysis technique helpful in determining market potential, business transactions, and the user interactions, etc. + +When a use case has been developed (i.e. become stable), possible network solution(s) may be developed. + +It is anticipated that future complex services will require a systematic analysis method to evaluate the network impacts. + +There is a desire to migrate away from developing a solution for each service opportunity on an individual case-by-case basis, and to deploy a consistent approach in order that the network architecture solution may be used to provide many different service needs. + +## B.1 Create a subscription for a new subscriber + +| Use Case Stage | Evolution / Specification | <>
Related use case | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| Goal | To fulfil a subscription for a new subscriber with one or more users in order to allow the users access to the subscribed services.
Performance: Near real time | | +| Actor(s) and Role(s) | Service Provider
Network Operator | | +| Assumptions | (a) Subscriber credit worthiness has been determined by other systems, techniques and mechanisms which are outside the subscription management system boundary.
(b) Levels of trust for subscribers and users have been determined by other systems, techniques and mechanisms outside of the subscription management system boundary
(c) The Contract contains the number of users and the set of services these may use.
(d) For each user the services she/he may use are also defined base on the above mentioned set of subscribed services. | | +| Pre conditions | (a) The services that can be offered by the network have been defined.
(b) Sufficient resources are available to support the anticipated take up of services by users. | | +| Begins when | A subscriber has signed a new contract with the Service Provider and/or Network Operator | | +| Step 1 | Create the subscriber profile and populate it with the set of services subscribed to the subscriber including subscriber specific settings and preferences for the subscribed services.
Associated information element(s): Subscriber Profile, Subscribed Services Profile | | +| Step 2 | For each user create a subscription profile using the Create a subscription for a new user use case
Associated information element(s): Subscription Profile | Create a subscription for a new user | +| Step 3 | For each user modify her/his subscription profile to fulfil the services in the network using the Modify a subscription for an existing user use case.
Associated information element(s): Subscription Profile, Service Profile | Modify a subscription for an existing user | +| Ends when | The network allows the users to use their subscribed services
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Conditions | A subscriber profile has been created and populated with the set of subscribed services.
The subscription profiles for each user have been created and populated with data necessary for the usage of their subscribed services.
Associated information element(s): Subscriber Profile, Subscribed Services Profile, Subscription Profile, Service Profile | | +| Traceability | Requirements:
Each type of services offered requires the ability to uniquely identify it.
To support self care it will be necessary to be able to correlate services references in a subscription, to the subscription profiles in the network.
It will be necessary to be able to audit the capabilities in a subscription against the subscription profile(s) in the network elements. | | + +## B.2 Modify subscription for an existing subscriber + +| Use Case Stage | Evolution / Specification | <>
Related use case | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| Goal | To modify the services and related terms and conditions which apply to a particular subscription.
This is expected to result from contract re-negotiation, where the resulting changes need to be applied to the affected users within the network.
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator
Service Provider | | +| Assumptions | The Contract changes are known and may be any variation of:
removal of users,
addition of new users,
removal of services subscribed,
newly subscribed services,
modified subscribed services
The subscriber is still credit and trust worthy.
(The checks for this are performed outside of SuM, but SuM needs to have access to this kind of information) | | +| Pre conditions | (a) The services that can be offered by the network have been defined.
(b) Sufficient resources are available to support the anticipated take up of services by users.
(c) The Subscriber already exists in the network.
(d) Users to be modified or deleted already exist in the network. | | +| Begins when | The contractual details have been modified. | | +| Step 1 | Modify the list of subscribed services in the subscriber profile including subscriber specific settings for the subscribed services.
Associated information element(s): Subscriber Profile, Subscribed Services Profile. | | +| Step 2 | For each user no longer part of this subscription remove her/his subscription profile by utilizing the Use Case Delete a subscription from an existing user
Associated information element(s): Subscription Profile. | Delete a subscription from an existing user | +| Step 3 | For each new user create a subscription profile using the Create a subscription for a new user use case
Associated information element(s): Subscription Profile | Create a subscription for a new user | +| Step 4 | For each new user add their subscribed services to her/his subscription profile using the Modify a subscription for an existing user use case.
Associated information element(s): Subscription Profile, Service Profile. | Modify a subscription for an existing user | +| Step 5 | For each already existing user subject to subscription and service changes modify her/his subscription profile to fulfil the services in the network using the Modify a subscription for an existing user use case.
Associated information element(s): Subscription Profile, Service Profile. | Modify a subscription for an existing user | +| Ends when | The network allows the users to use their subscribed services within the modified contract limits
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails. | | +| Post Conditions | Services in the contract align with services in the subscriber profile and the subscription profiles. Number of users in the contract aligns with the number of users in the network under this subscription.
Associated information element(s): Subscriber Profile, Subscribed Services Profile, Subscription Profile, Service Profile. | | +| Traceability | Requirements:
(a) Each type of services offered requires the ability to uniquely identify it.
(b) To support self care it will be necessary to be able to correlate services references in a subscription, to the subscription profiles in the network.
(c) It will be necessary to be able to audit the capabilities in a subscription against the subscription profile(s) in the network elements. | | + +## B.3 Delete subscription from an existing subscriber + +| Use Case Stage | Evolution / Specification | <>
Related use case | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| Goal | Remove the Subscriber and all users contained in the contract.
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator
Service Provider | | +| Assumptions | There is a way of confirming that a user is to be removed from using network services.
This is to ensure compliance with any country or region specific legislation regarding access to such things as emergency calls. | | +| Pre conditions | (a) The Subscriber to be deleted exists in the network
(b) Users to be deleted exist in the network | | +| Begins when | A subscription expires or has been terminated. | | +| Step 1 | Remove each user contained within the subscription using the Delete a subscription from an existing user use case.
Associated information element(s): Subscription Profile, Service Profile. | Delete a subscription from an existing user | +| Step 2 | Delete the subscriber profile
Associated information element(s): Subscriber Profile, Subscribed Services Profile. | | +| Ends when | The users who were contained in the contract are no longer able to use services in this network
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails. | | +| Post Conditions | The subscriber's subscriber profile and subscription profiles have been removed from the network elements in this operator's network.
Trace Logs, and contractual references are not automatically removed in case of any legal issues that require closure.
Subscription profile data, which would enable access to services, is removed.
Subscriber profile data is removed.
Associated information element(s): Subscriber Profile, Subscribed Services Profile, Subscription Profile, Service Profile. | | +| Traceability | | | + +## B.4 Get subscription details of an existing subscriber + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| Goal | Get subscription details on number of users and their subscribed services stored in the network.
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator
Service Provider
Subscriber | | +| Assumptions | The information provided for Network Operator is broader than for Subscriber | | +| Pre conditions | The Subscriber already exists in the network | | +| Begins when | Network Operator, Service Provider or Subscriber request information on subscription stored in the network elements | | +| Step 1 | Get information contained in Subscriber's subscriber profile
Associated information element(s): Subscriber Profile, Subscribed Services Profile | | +| Step 2 | For each user contained within the subscription get the information contained in her/his subscription profile using the use case 'Get subscription details of an existing user'
Associated information element(s): Subscription Profile, Service Profile | Get subscription details of an existing user | +| Ends when | The subscriber's subscriber profile and subscription profiles have been read from the network elements in this operator's network
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Conditions | The details contained in the contract and stored in network elements are unchanged.
The subscriber's subscriber profile and subscription profiles details are provided to the requestor.
Associated information element(s): Subscriber Profile, Subscribed Services Profile, Subscription Profile, Service Profile | | +| Traceability | | | + +## B.5 Create a subscription profile for a new user + +| Use Case Stage | Evolution / Specification | <>
Related use case | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| Goal | To add a new user associated with a subscription to the network.
Performance: Near real time | | +| Actor(s) and Role(s) | Service Provider
Network Operator
Subscriber | | +| Assumptions | (a) The services that can be offered by the network have been defined.
(b) Sufficient resources are available to support the delivery of services to users.
(c) The Contract contains the set of services the user may use. | | +| Pre conditions | (a) The Subscriber already exists in the network | | +| Begins when | A subscriber has signed a new contract with the Service Provider and/or Network Operator or has extended an existing contract with additional user(s). | | +| Step 1 | Create the user's subscription profile and populate it with the set of identifications and other data common to services.
Associated information element(s): Subscription Profile | | +| Ends when | The user is known in the network.
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Conditions | The network holds the subscription profile for the user.
Associated information element(s): Subscription Profile | | +| Traceability | | | + +## B.6 Modify a subscription for an existing user + +| Use Case Stage | Evolution / Specification | <>
Related use case | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| Goal | To modify the set of identifications and/or the services and related settings and preferences which apply to a particular user.
This is expected to result either from a new contract or from contract re-negotiation, where the resulting changes need to be applied to the affected users within the network.
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator
Service Provider
Subscriber | | +| Assumptions | The Contract changes are known and may be any variation of:
Change of user's set of identifications,
removal of services subscribed,
newly subscribed services,
modified service settings and preferences | | +| Pre conditions | The user already exists in the network | | +| Begins when | The user has been newly added to the network
or
the contractual details concerning a user or the services subscribed for him have changed (which may be both additions and/or withdrawals) | | +| Step 1 | IF the user's set of identifications and other data common to services are to be modified, align her/his subscription profile.
Associated information element(s): Subscription Profile | | +| Step 2 | IF the user has access to services which are no longer part of the contract, then delete them from the user's Subscription Profile using the Use Case Delete Service
Associated information element(s): Subscription Profile, Service Profile | Delete Service | +| Step 3 | Modify the existing subscription profile to fulfil the subscribed services in the network using the Add Service use case.
Associated information element(s): Subscription Profile, Service Profile | Add Service | +| Step 4 | Modify existing service profiles in the user's subscription profile to fulfil the services in the network using the Modify Service use case.
Associated information element(s): Subscription Profile, Service Profile | Modify Service | +| Ends when | The network allows the user to use his subscribed services within the contract limits
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Conditions | Services in the contract align with services in the subscription profile.
Associated information element(s): Subscription Profile, Service Profile | | +| Traceability | | | + +## B.7 Delete a subscription from an existing user + +| Use Case Stage | Evolution / Specification | <>
Related
use case | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| Goal | Remove a user contained in the contract
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator
Service Provider
Subscriber | | +| Assumptions | There is a way of confirming that a user is to be removed from using network services.
This is to ensure compliance with any country or region specific legislation regarding access to such things as emergency calls. | | +| Pre conditions | The user already exists in the network | | +| Begins when | A subscription expires or the number of users contained in the subscription is reduced | | +| Step 1 | Remove the user that is no longer contained within the subscription by deleting relevant subscription profile.
Associated information element(s): Subscription Profile, Service Profile | | +| Ends when | The user who was removed from the subscription is no longer able to use services in this network
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Conditions | The user's subscription profile has been removed from the network elements in this operator's network.
Trace Logs, and contractual references are not automatically removed in case of any legal issues that require closure.
Only subscription profile data which would enable access to services are removed.
Associated information element(s): Subscription Profile, Service Profile | | +| Traceability | | | + +## B.8 Get subscription details of an existing user + +| Use Case Stage | Evolution / Specification | <>
Related
use | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| Goal | Get details for the user contained in the subscription and stored in the network
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator
Service Provider
Subscriber
User | | +| Assumptions | The information provided for Network Operator is broader than for Subscriber, which might still be broader than that for the user. | | +| Pre conditions | The user already exists in the network | | +| Begins when | Network Operator, Subscriber or User request information on User stored in the network elements | | +| Step 1 | Get the information contained in the subscription profile for the user
Associated information element(s): Subscription Profile, Service Profile | | +| Ends when | The user's subscription profile has been read from the network elements in this operator's network. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Conditions | The details contained in the contract and stored in network elements are unchanged
Associated information element(s): Subscription Profile, Service Profile | | +| Traceability | | | + +## B.9 Add service + +| Use Case Stage | Evolution / Specification | <>
Related use case | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| Goal | Allow the user accessing a service in the case of fulfilling a subscription for a new subscriber or subscription extension for an existing subscriber with one or more users or a service has been added to the contract for the user

Performance: Near real time. | | +| Actor(s) and Role(s) | Service Provider
Network Operator
Subscriber | | +| Assumptions | (a) The services that can be offered by the network have been defined.
(b) Sufficient resources are available to support the delivery of services to users.
(c) The Contract contains this service the user wants to use. | | +| Pre conditions | (a) The user already exists in the network
(b) The user has no access to the service | | +| Begins when | A subscriber has signed a new contract with the service provider or has extended an existing contract with additional user(s) or has extended the services the existing user may use. | | +| Step 1 | Within the user's subscription profile, update the service profile and populate it with the set of preferences and settings subscribed.
Associated information element(s): Subscription Profile, Service Profile. | | +| Ends when | The user can use the service in the network.
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails. | | +| Post Conditions | The network holds the extended subscription profile for the user.
Associated information element(s): Subscription Profile, Service Profile. | | +| Traceability | | | + +## B.10 Modify service + +| Use Case Stage | Evolution / Specification | <>
Related use case | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| Goal | To modify the set of settings and preferences which apply to a service for a particular user.
This is expected to result from contract re negotiation, where the resulting changes need to be applied to the affected users within the network
or
subscriber or user initiated changes.
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator
Service Provider
Subscriber
User | | +| Assumptions | The Contract changes are known and may be any variation of:
Change of user's preferences
Change of user's service related settings | | +| Pre conditions | (a) The user already exists in the network
(b) The user has access to the service | | +| Begins when | The contractual details have been modified
or a decision for settings and preferences changes has been taken | | +| Step 1 | Within the user's subscription profile modify the existing service profile to change the service preferences and settings in the network
Associated information element(s): Subscription Profile, Service Profile | | +| Ends when | The network allows the user to use his subscribed services within the contract limits.
The updated set of settings and preferences are now operative.
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Conditions | The service settings and preferences defined and agreed in the contract or wanted by the user now align with service settings and preferences in the service profile.
Associated information element(s): Subscription Profile, Service Profile | | +| Traceability | | | + +## B.11 Delete service + +| Use Case Stage | Evolution / Specification | <>
Related
use case | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| Goal | Remove a service contained in the contract for one user
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator
Subscriber | | +| Assumptions | There is a way of confirming that a user is to be denied access to certain network services.
This is to ensure compliance with any country or region specific legislation regarding access to such things as emergency calls. | | +| Pre conditions | (a) The user already exists in the network
(b) The user has access to the service | | +| Begins when | A subscription expires
or Subscriber credit worthiness or trust have been lost
or existing user(s) are deleted from the contract
or a service is deleted from the contract for all or only for one user | | +| Step 1 | In the user's subscription profile delete the existing service profile to inhibit access to the service in the network
Associated information element(s): Subscription Profile, Service Profile | | +| Ends when | The user's subscription profile has been removed from the network elements in this operators network. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Condition | The user who was contained in the contract is no longer able to use services in this network.
Trace Logs, and contractual references are not automatically removed in case of any legal issues that require closure.
Only subscription profile data which would enable access to services are removed.
Associated information element(s): Subscription Profile, Service Profile | | +| Traceability | | | + +## B.12 Get service details + +| Use Case Stage | Evolution / Specification | <>
Related
use | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| Goal | Get details (settings and preferences) of the user's access to a service stored in the network
Performance: Near real time | | +| Actor(s) and Role(s) | Service Provider
Network Operator
Subscriber | | +| Assumptions | There is a way of confirming that a user is to be denied access to certain network services.
This is to ensure compliance with any country or region specific legislation regarding access to such things as emergency calls. | | +| Pre conditions | (a) The user already exists in the network
(b) The user has access to the service | | +| Begins when | A subscription expires
or Subscriber credit worthiness or trust have been lost
or existing user(s) are deleted from the contract
or a service is deleted from the contract for all or only for one user | | +| Step 1 | In the user's subscription profile, update the existing service profile to inhibit access to the service in the network
Associated information element(s): Subscription Profile, Service Profile | | +| Ends when | The user who was contained in the contract is no longer able to use the service in this network
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails | | +| Post Condition | The user's subscription profile has been updated and related service profile has been removed from the network elements in this operator's network.
Trace Logs, and contractual references are not automatically removed in case of any legal issues that require closure.
Only subscription profile data which would enable access to services are removed.
Associated information element(s): Subscription Profile, Service Profile | | +| Traceability | | | + +## B.13 Create and activate prepaid subscription for a new subscriber + +| Use Case Stage | Evolution / Specification | <>
Related
use case | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| Goal | Create a prepaid subscription for a subscriber and associate (activate) it to all users in the contract.
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator | | +| Assumptions | (a) Payment is handled by mechanisms outside of the subscription management system boundary.
(b) The Contract contains the number of users and the set of services these may use.
(c) For each user, the services she/he may use are also defined based on the above mentioned set of subscribed services. | | +| Pre conditions | (a) Services that can be used by a prepaid user are offered by the network.
(b) Sufficient resources should be available to support the anticipated take up of services by users. | | +| Begins when | A subscriber has signed a new contract with the operator as a prepaid subscriber | | +| Step 1 | Create the subscriber profile and populate it with the set of services entitled to by the Contract for the prepaid subscription, including subscriber specific settings and preferences for the subscribed services.
Associated information element(s): Subscriber Profile, Subscribed Services Profile | | +| Step 2 | For each new user create a subscription profile using the Create a subscription for a new user use case
Associated information element(s): Subscription Profile | Create a subscription for a new user | +| Step 3 | For each new user add their subscribed services to her/his subscription profile by using the Modify a subscription for an existing user use case.
Associated information element(s): Subscription Profile, Service Profile. | Modify a subscription for an existing user | +| Ends when | The network allows the users to use their subscribed services within the contract limits for the prepaid subscription
OR
an error condition has been encountered. | | +| Exceptions | Any of the steps of this use case fails. | | +| Post Condition | A subscriber profile has been created and populated with the set of subscribed service(s).
The subscription profiles for each user have been created and populated with data necessary for the usage of their subscribed services.
Associated information element(s): Subscriber Profile, Subscribed Services Profile, Subscription Profile, Service Profile. | | +| Traceability | | | + +## B.14 Delete prepaid subscription + +| Use Case Stage | Evolution / Specification | <>
Related
use case | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| Goal | Remove the Subscriber of the prepaid subscription and all users in the contract.
Performance: Near real time | | +| Actor(s) and Role(s) | Network Operator | | +| Assumptions | Same as for Use Case Delete subscription from an existing subscriber | | +| Pre conditions | Same as for Use Case Delete subscription from an existing subscriber | | +| Begins when | The prepaid subscription has been inactive for a pre-defined period of time, triggering the deletion of the prepaid subscription
OR
another condition triggers the termination of the subscription. | | +| Step 1 | Delete the subscription through the Use Case Delete subscription from an existing subscriber | Delete subscription from an existing subscriber | +| Ends when | The subscriber's subscriber profile for the prepaid subscription and subscription profiles have been removed. | | +| Exceptions | Any of the steps of this use case fails. | | +| Post Condition | Same as for Use Case Delete subscription from an existing subscriber | | +| Traceability | | | + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-------|-----|----------------------------------------------------------------------------------------------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| Mar 2002 | SA 15 | SP-020012 | -- | -- | Submitted to SA#15 as v1.0.0 for Information | 1.0.0 | -- | +| Dec 2002 | SA 18 | SP-020728 | -- | -- | Submitted to SA#18 as v1.1.1 for Information | 1.1.1 | -- | +| Mar 2003 | SA 19 | SP-030041 | -- | -- | Submitted to SA#19 as v2.0.0 for Approval | 2.0.0 | 6.0.0 | +| Sep 2003 | SA_21 | SP-030404 | 0001 | -- | Correction to figure 3 (Architecture for management of Subscription Profile components) | 6.0.0 | 6.1.0 | +| Mar 2004 | SA_23 | SP-040108 | 0002 | -- | Subscription Management TS-family (32.14x and 32.17x) title alignment ("SM" becomes "SuM" and delete "Services operations management") | 6.1.0 | 6.2.0 | +| Mar 2004 | SA_23 | SP-040110 | 0003 | -- | Update the use cases in SuM | 6.1.0 | 6.2.0 | +| Dec 2004 | SA_26 | SP-040764 | 0004 | -- | Editorial corrections and updates of Subscription Management (SuM) requirements | 6.2.0 | 6.3.0 | +| Dec 2004 | SA_26 | SP-040764 | 0005 | -- | Change the Introduction clause to reflect what capability SuM is offering in Rel-6 | 6.2.0 | 6.3.0 | +| Jun 2007 | SA_36 | SP-070269 | 0005a | -- | Remove incorrect dependency | 6.3.0 | 6.4.0 | +| Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Cleaned-up references. | 6.4.0 | 7.0.0 | +| Dec 2008 | SA_42 | -- | -- | -- | Upgrade to Release 8 | 7.0.0 | 8.0.0 | +| Sep 2008 | SA_45 | SP-090627 | | | Updates for mapping to eTOM | 8.0.0 | 9.0.0 | +| Dec 2009 | SA_46 | SP-090719 | 0007 | -- | Refining and adding more SuM use cases | 9.0.0 | 9.1.0 | +| Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.1.0 | 10.0.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 10.0.0 | 11.0.0 | +| 2013-06 | SA_60 | SP-130304 | 0008 | 2 | SuM Reqs | 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-10 | - | - | - | - | 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 | +| 2022-03 | - | - | - | - | Update to Rel-17 version (MCC) | 16.0.0 | 17.0.0 | +| 2024-04 | - | - | - | - | Update to Rel-18 version (MCC) | 17.0.0 | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/32_series/32141/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32141/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4de7dd97b9337b3aaf072e746405ad520d5d45de --- /dev/null +++ b/marked/Rel-18/32_series/32141/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b42d116d8c2d814c86377d52a84e0f5d4ef04fd6b66457e5edf7e3dd2ea4cb7 +size 9370 diff --git a/marked/Rel-18/32_series/32141/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32141/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..befa7d0aab7a27d907df9a48accf6d9115609306 --- /dev/null +++ b/marked/Rel-18/32_series/32141/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9faff289c269ff2b0f41d2267933e4cc43c36969d345e79d9a3b32ee4d7b5dbd +size 5420 diff --git a/marked/Rel-18/32_series/32141/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-18/32_series/32141/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95b16a42dcb78416b9cd639812890fca0308a13d --- /dev/null +++ b/marked/Rel-18/32_series/32141/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ed96e4a1bbe30e9039003e7573fecacc73fa213275d65ff140914e29ae207ded +size 22096 diff --git a/marked/Rel-18/32_series/32141/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-18/32_series/32141/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c1e74ca70f015b31308c6c11446c12121895d522 --- /dev/null +++ b/marked/Rel-18/32_series/32141/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:246139e7fd51a44757a6123c495231a7028a55a3eec21bcc847c0fceca057091 +size 52605 diff --git a/marked/Rel-18/32_series/32141/dbe553cf16dd14073b89a8263a428664_img.jpg b/marked/Rel-18/32_series/32141/dbe553cf16dd14073b89a8263a428664_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dc999bebeb365a86ae56ed1a0a4ac77502d66ec8 --- /dev/null +++ b/marked/Rel-18/32_series/32141/dbe553cf16dd14073b89a8263a428664_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bca3286a6563ec94c0681b56c8f267c3e40090227d66f7a637828f4ff41a11d7 +size 45773 diff --git a/marked/Rel-18/32_series/32141/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-18/32_series/32141/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..44acdb32eba212331fc9b0fa5178d6f11f9064ac --- /dev/null +++ b/marked/Rel-18/32_series/32141/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62578659e231ddb0c9bd18c2a9ab880e10ddffd8513c6ebec0bbf233b813ace0 +size 22685 diff --git a/marked/Rel-18/32_series/32141/raw.md b/marked/Rel-18/32_series/32141/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a7cd179da3609126939b8f95cdd8809bfd7b17ab --- /dev/null +++ b/marked/Rel-18/32_series/32141/raw.md @@ -0,0 +1,377 @@ + + +# 3GPP TS 32.141 V18.0.0 (2024-04) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Subscription Management (SuM) architecture (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, black font. + +3GPP logo + +## --- **Keywords** + +Subscription Management, Converged +Management , architecture + +### **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. + +© 2024, 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 Subscription Management (SuM) architecture ..... | 6 | +| 4.1 Functional entities ..... | 7 | +| 4.2 Interfaces ..... | 8 | +| 4.2.1 Application of Itf-N for SuM ..... | 8 | +| 4.2.2 Void ..... | 8 | +| 4.3 Overview of IRP..... | 8 | +| 4.3.1 IRP security ..... | 9 | +| 4.4 Methodology ..... | 9 | +| 4.4.1 SuM Stage 1 ..... | 9 | +| 4.4.2 SuM Stage 2 ..... | 9 | +| 4.4.3 SuM Stage 3 ..... | 10 | +| Annex A (informative): Void..... | 11 | +| Annex B (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. + +## 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 a TS-family covering the 3rd 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 32.171: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements". + +TS 32.172: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". + +TS 32.176: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions". + +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". + +The 3G environment requires more complex service delivery mechanisms and is no longer simply an internal matter for a single operator but a capability that is achieved by linking together features across multiple service providers and + +operators. 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. + +For further details see 3GPP TS 32.140 [5] on SuM requirements that gives an overview of SuM. + +# --- 1 Scope + +The present document defines the architecture for Subscription Management (SuM) , including Converged Management of fixed and 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 TS 23.002: "Network Architecture". +- [3] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [4] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [5] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) requirements". +- [6] 3GPP TS 23.008: "Organization of subscriber data". +- [7] 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 following terms and definitions apply: + +**subscriber:** See 3GPP TR 21.905 [1]. + +**service:** See 3GPP TR 21.905 [1]. + +**Integration Reference Point (IRP):** See 3GPP TS 32.101 [3]. + +**user:** See 3GPP TR 21.905 [1]. + +**subscription:** See 3GPP TR 21.905 [1]. + +**Subscription Management (SuM):** See 3GPP TR 32.140 [5]. + +**Subscription Profile:** See 3GPP TR 32.140 [5]. + +**Subscription Profile Component:** See 3GPP TR 32.140 [5]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|--------------------------------------------------| +| 2G | Second Generation Mobile | +| 3G | Third Generation Mobile | +| API | Application Programming Interface | +| ASP | Application Service Provider | +| AuC | Authentication Center | +| B2B | Business to Business | +| CS | Circuit Switch | +| EIR | Equipment Identity Register | +| GTT | Global Text Telephony | +| GUP | Generic User Profile | +| HE | Home Environment | +| HLR | Home Location Register | +| HSS | Home Subscriber Server | +| IMS | IP Multimedia Subsystem | +| IRP | Integration Reference Point (3GPP TS 32.102 [4]) | +| ISP | Internet Service Provider | +| NPDB | Number Portability Data Base | +| NRM | Network Resource Model | +| OAM | Operations, Administration and Maintenance | +| OSA | Open Services Access | +| OSF | Operations System Functions | +| OSS | Operations Support System | +| PS | Packet Switch | +| SLA | Service Level Agreement | +| SM&O | Service Management and Operations (TMF/ITU-T) | +| SP | Service Provider | +| SuM | Subscription Management | +| TMN | Telecommunication Management Network | +| TR-IRP | Trading Partner IRP | +| UICC | Universal Integrated Circuit Card | +| USIM | Universal Subscriber Identity Module | +| VASP | Value Added Service Provider | +| VHE | Virtual Home Environment | +| VNO | Virtual Network Operator | + +# --- 4 Subscription Management (SuM) architecture + +3G Telecommunication Management focuses on the most important and strategic contexts in the physical architecture for the management of UMTS. The framework to help define a telecom management physical architecture for a planned UMTS and to adopt standards and provide products that are easy to integrate is defined in 3GPP TS 32.102 [4]. + +SuM manages Subscription Profile Components stored in network resources for the purpose of providing services to specific subscribers. This is done with an architecture that is consistent with the one specified in 3GPP TS 32.102 [4]. + +Subscription Profiles represent services and are associated to subscribers that employ these services (3GPP TS 32.140 [5]). To the extent the HSS controls certain services, Subscription Profile Components can be associated with the HSS. Other services, and as a result Subscription Profiles Components, are outside the jurisdiction of the HSS. + +## 4.1 Functional entities + +Functional entities belonging to SuM are described in Figure 1. The figure also contains the actors related to Subscriptions. + +![Figure 1: Functional entities in SUM. This UML class diagram shows the relationships between actors (PLMN operator/Service Provider, Subscriber, User) and entities (Service, Subscription Profile, Service Preferences, Subscription Profile Component, System). A dashed oval labeled 'SM&O mapping of information entities' encloses Service, Subscription Profile, and Service Preferences. Relationships include 'Has', 'Refers to', 'Consists of', 'Defines', and 'Resides in'.](c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg) + +``` + +classDiagram + actor PLMN_operator_Service_Provider as PLMN operator/Service Provider + actor Subscriber + actor User + class Service + class Subscription_Profile as Subscription Profile + class Service_Preferences as Service Preferences + class Subscription_Profile_Component as Subscription Profile Component + class System + + PLMN_operator_Service_Provider "1" -- "0..n" Service : Has + Subscriber "1" -- "0..n" Subscription_Profile : Has + User "1" -- "0..n" Service_Preferences : Has + Service "1" -- "0..n" Subscription_Profile : Refers to + Subscription_Profile "1" -- "0..n" Subscription_Profile_Component : Consists of + Subscription_Profile "1" -- "0..n" Service_Preferences : Defines + Subscription_Profile_Component "0..n" -- System : Resides in + + subgraph SM_O_mapping_of_information_entities [SM&O mapping of information entities] + Service + Subscription_Profile + Service_Preferences + end + +``` + +Figure 1: Functional entities in SUM. This UML class diagram shows the relationships between actors (PLMN operator/Service Provider, Subscriber, User) and entities (Service, Subscription Profile, Service Preferences, Subscription Profile Component, System). A dashed oval labeled 'SM&O mapping of information entities' encloses Service, Subscription Profile, and Service Preferences. Relationships include 'Has', 'Refers to', 'Consists of', 'Defines', and 'Resides in'. + +Figure 1: Functional entities in SUM + +Actors described in Figure 1 are: + +- **Subscriber** (definition See TS 21.905) +- **User** (definition See TS 21.905) +- **Service Provider** (definition See TS 21.905) +- **PLMN Operator** (definition See TS 21.905) + +The entities described in Figure 1 are: + +- **Subscription Profile** (definition See TS 32.140) +- **Subscription Profile Component** (definition See TS 32.140) +- **Service** (definition See TS 21.905) +- **System** (definition See TS 32.102) +- **Service Preferences**: Contains the service preferences chosen for a user. Each user configures his preferences for a particular subscribed service, but only within the limits defined by the Subscription. + +### Clarifications to the figure: + +- A PLMN Operator/Service Provider has one or several Services to offer for Subscribers. +- A Subscriber has one or several Subscription Profiles, where each describes an offered Service. +- A User has one or several Service Preferences, where each describes the user's chosen preferences for the service. + +- A Subscription Profile may consist of one or several Subscription Profile Components. +- A Subscription Profile may define one or several Service Preferences. +- A Subscription Profile Component resides in one or several systems +- Subscriptions are managed in the form of Subscription profile components, which may be distributed across Service Management & Operations (SM&O), Network Resource Management & Operations (RM&O) and Network Domains. There may also be mappings among the SM&O, RM&O and Network Domains. + +## 4.2 Interfaces + +### 4.2.1 Application of Itf-N for SuM + +![Figure 2: Overview of PLMN Telecom Management Domains and Itf-N (3GPP TS 32.102 [4]). The diagram shows a hierarchy of management domains. At the top is a box labeled 'OSF for Network Management and Service Management'. Below it, a vertical line labeled 'Itf-N' connects to a larger box. This box contains four sub-domains: 'OSF User Equipment Domain', 'OSF Access Network Domain', 'OSF Core Network Basic Entities Domain' (which is further divided into 'Common CN Domain', 'CS Domain', and 'PS (GPRS) Domain'), and 'OSF Core network Service Specific entities'. To the right of this box is the label 'NE Management'.](dbe553cf16dd14073b89a8263a428664_img.jpg) + +Figure 2: Overview of PLMN Telecom Management Domains and Itf-N (3GPP TS 32.102 [4]). The diagram shows a hierarchy of management domains. At the top is a box labeled 'OSF for Network Management and Service Management'. Below it, a vertical line labeled 'Itf-N' connects to a larger box. This box contains four sub-domains: 'OSF User Equipment Domain', 'OSF Access Network Domain', 'OSF Core Network Basic Entities Domain' (which is further divided into 'Common CN Domain', 'CS Domain', and 'PS (GPRS) Domain'), and 'OSF Core network Service Specific entities'. To the right of this box is the label 'NE Management'. + +**Figure 2: Overview of PLMN Telecom Management Domains and Itf-N (3GPP TS 32.102 [4])** + +The Itf-N for SuM is realized by means of an Integration Reference Point (IRP) as defined in 3GPP TS 32.102 [4]. + +Operations System Functions (OSF) functionality can be realized in NEs or in the NE Management systems. SuM, for this release, is concerned with the OSF functionality contained in the Core Network Basic Entities Domain and specifically that of the Common CN Domain. Subscription Profile Components are located in the NEs OSF's within the Common CN Domain or their NEs OSF's in the NE management systems, and are in either case accessed consistent with the IRP concept. SuM OSF's for Network Management and Service Management are located in network- and service management systems. + +### 4.2.2 Void + +## 4.3 Overview of IRP + +Figures 3 and 4 identify system contexts of the IRP in terms of its implementation, called IRPAgent (see 3GPP TS 32.150 [7]), and the user of the IRPAgent, called IRPManager (see 3GPP TS 32.150 [7]). + +The IRPAgent implements and supports the Interface IRPs for SuM NRM IRP. The IRPAgent can reside in an Element Manager (EM) or a Network Element (NE) (3GPP TS 32.102 [4]). In the former case, the interface (represented by a thick dotted line) between the EM and the NEs is not the subject of the Interface IRPs for SuM NRM IRP. + +An IRPManager using the Interface IRPs for SuM NRM IRP shall choose one of the two System Contexts defined here, for each NE. For instance, if an EM is responsible for managing a number of NEs, the NM shall access the Interface IRPs for SuM NRM IRP through the EM and not directly to those NEs. + +The interface IRPs for SuM NRM IRP can be the following: + +- Basic CM IRP + +![Figure 3: System Context A](e6df2733626a85205c1db682e6259c46_img.jpg) + +A block diagram showing System Context A. On the left, a box labeled 'NM' contains a smaller box labeled 'IRPManager'. A solid horizontal line connects the 'IRPManager' to a box labeled 'IRPAgent' inside a larger box labeled 'EM' on the right. A dotted line extends from the 'IRPAgent' to a box labeled 'NEs'. A vertical dashed line separates the NM and EM domains. An arrow labeled 'Itf-N' points to this dashed line from a text block below that reads 'Interface IRPs for SuM NRM IRP'. + +Figure 3: System Context A + +**Figure 3: System Context A** +![Figure 4: System Context B](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +A block diagram showing System Context B. On the left, a box labeled 'NM' contains a smaller box labeled 'IRPManager'. A solid horizontal line connects the 'IRPManager' to a box labeled 'IRPAgent' inside a larger box labeled 'NE' on the right. A vertical dashed line separates the NM and NE domains. An arrow labeled 'Itf-N' points to this dashed line from a text block below that reads 'Interface IRPs for SuM NRM IRP'. + +Figure 4: System Context B + +**Figure 4: System Context B** + +### 4.3.1 IRP security + +The IRP interface is made secure by controlling access to the network and management systems. Operations processes must insure that only authorized personnel have the access authority to retrieve and alter SuM data. Standard protocols used over the interface between the IRPManager and the IRPAgent provide some degree of security. The exact nature of the security is described in the Solution Set for that protocol. In addition to the requirement that the IRPManager and the IRPAgent be secure, most physical links between them are secured as well. + +## 4.4 Methodology + +The methodology used to conclude the standard work for SuM shall follow the IRP methodology described in 3GPP TS 32.150 [4]. This subclause describes how to apply that methodology. + +### 4.4.1 SuM Stage 1 + +SuM Stage 1 is documented in 3GPP TS 32.140 [5]. + +### 4.4.2 SuM Stage 2 + +SuM Stage 2 is documented as follows: + +- a) The present document (3GPP TS 32.141) is finalized by identifying the relevant IRPs. +- b) 3GPP TS 32.171 (for non-converged management) and TS 28.751 (for converged management) define the Requirements for the SuM NRM IRP. + 3GPP TS 32.171 and TS 28.751 shall, where applicable, follow the structure in 3GPP TS 32.621 (for non-converged management) and TS 28.621 (for converged management) (Generic NRM IRP: Requirements), respectively. +- c) 3GPP TS 32.172 (for non-converged management) and TS 28.752 (for converged management) describe the Information Service for the SuM NRM IRP – containing the Information Object Classes (IOCs), attributes, + +relations etc. for SuM. + +3GPP TS 32.172 and TS 28.752 shall, where applicable, follow the structure in 3GPP TS 32.622 (for non-converged management) and TS 28.622 (for converged management) (Generic NRM IRP: Information Service) , respectively. + +### 4.4.3 SuM Stage 3 + +SuM Stage 3 is documented in the following documents: + +- TS 32.176 (for non-converged management) and TS 28.623 (for converged management) SuM NRM IRP: Solution Set definitions. + +# --- Annex A (informative): Void + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|----------------------------------------------------------------------------------------------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| Mar 2003 | SA 19 | SP-030042 | -- | -- | Submitted to SA#19 as v1.0.0 for Information | 1.0.0 | -- | +| Sep 2003 | SA 21 | SP-030405 | -- | -- | Submitted to SA#21 as v2.0.0 for Approval | 2.0.0 | 6.0.0 | +| Mar 2004 | SA_23 | SP-040108 | 0001 | -- | Subscription Management TS-family (32.14x and 32.17x) title alignment ("SM" becomes "SuM" and delete "Services operations management") | 6.0.0 | 6.1.0 | +| Jun 2007 | SA 36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. | 6.1.0 | 7.0.0 | +| Dec 2008 | SA 42 | -- | -- | -- | Upgrade to Release 8 | 7.0.0 | 8.0.0 | +| Sep 2009 | SA 45 | SP-090627 | 0002 | -- | Align with TS 32.140 SuM requirements | 8.0.0 | 9.0.0 | +| Mar 2011 | - | - | - | - | 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 | +| 2013-06 | SA 60 | Sp-130304 | 0003 | 2 | SuM Arch | 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 | +| 2022-03 | - | - | - | - | Update to Rel-17 version (MCC) | 16.0.0 | 17.0.0 | +| 2024-04 | - | - | - | - | Update to Rel-18 version (MCC) | 17.0.0 | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/32_series/32150/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-18/32_series/32150/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..659eeb2f56960c6f3dbccbc8c63c33eca540715e --- /dev/null +++ b/marked/Rel-18/32_series/32150/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:472f55d09968f57cf68c7eba25fa701be1e5eeacb8d328f9b46ff18c7d3c77f1 +size 51419 diff --git a/marked/Rel-18/32_series/32150/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32150/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d96f3f60573f738f13ac4b8e2d0970412a5d651 --- /dev/null +++ b/marked/Rel-18/32_series/32150/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15bd801abca0e74f4311f792927a13e05d1eb264e32aa289242e33c2b3a9306a +size 9410 diff --git a/marked/Rel-18/32_series/32150/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32150/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f4d92ba1fb227979b6597aa136f102db156b5ca --- /dev/null +++ b/marked/Rel-18/32_series/32150/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b5903c995ceef9044fd55dc342194af254cc4e27b6c5ecb0193f2a073351881 +size 6076 diff --git a/marked/Rel-18/32_series/32150/70de8885bd7de15723aaad5eb5c5febf_img.jpg b/marked/Rel-18/32_series/32150/70de8885bd7de15723aaad5eb5c5febf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b98770cd377e715e48fbd3536cb4cb6b33f54c44 --- /dev/null +++ b/marked/Rel-18/32_series/32150/70de8885bd7de15723aaad5eb5c5febf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9bce8062c090bc668275680d15ee6aaff8ed0ae109953371ac4772b3c49e4967 +size 22195 diff --git a/marked/Rel-18/32_series/32150/8e14350b4b669119a3bdfca7869110ca_img.jpg b/marked/Rel-18/32_series/32150/8e14350b4b669119a3bdfca7869110ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6994004662c3f9633bd9b04750d85686c99c247d --- /dev/null +++ b/marked/Rel-18/32_series/32150/8e14350b4b669119a3bdfca7869110ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c6168d9b73c53b5aff0eaeed620a6bd73ba9138d1b31c0780de069536c8028e +size 78846 diff --git a/marked/Rel-18/32_series/32150/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg b/marked/Rel-18/32_series/32150/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4342a68db6d9948905c75edccb69e5e75e131c22 --- /dev/null +++ b/marked/Rel-18/32_series/32150/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:22c20b3af1a0b7aeb46e9be8244199fe910ac2351f789a6b2e699a1cd6c8ba7f +size 25993 diff --git a/marked/Rel-18/32_series/32150/fbfa653853daf5541118a9ddecb92284_img.jpg b/marked/Rel-18/32_series/32150/fbfa653853daf5541118a9ddecb92284_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..089ff9c69f646d3573c9bb7fce1ad86c7eb6a142 --- /dev/null +++ b/marked/Rel-18/32_series/32150/fbfa653853daf5541118a9ddecb92284_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99a3ea11a91ad53be1a83575a1e65fd2bd765e0a72e0b43ee20ad0ba3939fd45 +size 130008 diff --git a/marked/Rel-18/32_series/32150/raw.md b/marked/Rel-18/32_series/32150/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..95b72c90ddf9b2da883110f7976e1be01544ebfb --- /dev/null +++ b/marked/Rel-18/32_series/32150/raw.md @@ -0,0 +1,511 @@ + + +# 3GPP TS 32.150 V18.1.0 (2024-09) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Integration Reference Point (IRP) concept and definitions (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, black font. + +3GPP logo + +## --- **Keywords** + +UMTS, 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. + +© 2024, 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 ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 7 | +| 4 Integration Reference Points (IRPs) ..... | 8 | +| 4.1 Introduction ..... | 8 | +| 4.1.1 General ..... | 8 | +| 4.1.2 IRP Specifications Approach ..... | 9 | +| 4.2 Integration levels ..... | 10 | +| 4.2.1 Application integration ..... | 10 | +| 4.3 Application of IRPs ..... | 11 | +| 4.4 Defining the IRPs ..... | 12 | +| 4.5 Void..... | 12 | +| 4.6 Mandatory, Optional and Conditional qualifiers..... | 13 | +| 4.7 System context for Interface IRPs..... | 15 | +| 4.8 Object instance visibility..... | 16 | +| Annex A (informative): Void..... | 17 | +| Annex B (normative): Void..... | 18 | +| Annex C (informative): Void..... | 19 | +| Annex D (informative): Void..... | 20 | +| Annex E (normative): Void..... | 21 | +| Annex F (informative): Void..... | 22 | +| Annex G (normative): IOC Properties and Inheritance ..... | 23 | +| G.1 Property..... | 23 | +| G.2 Inheritance..... | 24 | +| Annex H (normative): Interface Properties and Inheritance ..... | 25 | +| H.1 Property..... | 25 | +| H.2 Inheritance..... | 25 | +| Annex I (normative): Entity (Interface, IOC and Attribute) Import..... | 26 | +| Annex K (informative): Change history ..... | 27 | + +# --- 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 32.150: Integration Reference Point (IRP) Concept and definitions.** + +- TS 32.153: Integration Reference Point (IRP) technology specific templates. +- TS 32.154: Backward and Forward Compatibility (BFC); Concept and definitions. +- TS 32.155: Telecommunication management; Requirements template. +- TS 32.156: Telecommunication management; Fixed Mobile Convergence (FMC) Model Repertoire. +- TS 32.157: Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template. + +# 1 Scope + +The present document provides the overall concept for all Integration Reference Point (IRP) specifications. Relevant IRP overview and high-level definitions are already provided in 3GPP TS 32.101 [1] and TS 32.102 [2]. + +IRP specifications are intended to be applicable to any management interface (see definition of Integration Reference Point in subclause 3.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 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] Void. +- [4] Void. +- [5] ITU-T Recommendation M.3020 (04/2023): "TMN Interface Specification Methodology". +- [6] Void +- [7] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point: Information Service (IS)". +- [8] 3GPP TS 32.601: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Requirements". +- [9] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (IS)". +- [10] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [11] 3GPP TS 28.621: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [12] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP) ; Information Service (IS)". +- [13] 3GPP TS 28.623: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP) ; Solution Set (SS) definitions". +- [14] Void. +- [15] Void. +- [16] Void. +- [17] Void. +- [18] 3GPP TS 32.156: " Fixed Mobile Convergence (FMC) Model Repertoire". + +- [19] 3GPP TS 32.157: " Integration Reference Point (IRP) Information Service (IS) template". +- [20] Void. +- [21] 3GPP TS 32.671: " Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP); Requirements". +- [22] 3GPP TS 32.672: " Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP); Information Service (IS)". +- [23] 3GPP TS 32.676: " Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP); Solution Set (SS) definitions". +- [24] 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 [24], 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.157 [19], 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 [24], 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], and 3GPP TS 32.157 [19]. + +**Data Definition IRP:** 3GPP publishes IRP specifications relating to commonly used data definitions that can be imported for use by Interface IRP and/or NRM IRP. This term represents all such specifications. + +NOTE 1: An example of a Data Definition IRP is the State Management IRP (32.671 [21], 32.672 [22], 32.676 [23]). + +**Information Object Class (IOC):** information that can be passed/used in management interfaces and is modelled using the stereotype "Class" in the UML meta-model. For a formal definition of Information Object Class and its structure of specification, see 3GPP TS 32.157 [19]. + +**Integration Reference Point (IRP):** An architectural concept that is described by a set of specifications for definition of a certain aspect of a management interface, comprising a **Requirements** specification, an **Information Service** specification, and one or more **Solution Set** specifications. + +**Interface IRP:** 3GPP publishes a number of IRP specifications each of which is related to a set of operations and notifications for a specific telecom management domain such as alarm management, configuration management, etc. Interface IRPs also contain definitions of SupportIOCs. This term represents all such specifications. + +NOTE 2: An example of an Interface IRP is the Basic CM IRP (the set of TSs 32.601 [8], 32.602 [9], 32.606 [10]). + +**IRPAgent:** Encapsulation of a well-defined subset of network (element) functions. It interacts with IRPManagers using one or more IRPs. From the IRPManager's perspective, the IRPAgent behaviour is only visible via the IRP(s). + +**Information Service (IS):** description of the information related to the entities (either network resources or support objects) to be managed and the way that the information may be managed for a certain functional area (e.g. the Alarm IRP Information Service in the fault management area). Information Services are defined for all IRPs. + +**IRPManager:** Modeling of a user of IRPAgent(s) which interacts directly with the IRPAgent(s) using IRP(s). Since the IRPManager represents an IRPAgent user, it gives a clear picture of what the IRPAgent is supposed to do. From the IRPAgent perspective, the IRPManager behaviour is only visible via the IRP. + +**Managed Object Class (MOC):** information that can be passed/used in management interfaces in a similar way to IOC. + +NOTE 3: See subclause 7.3.4.3 of ITU-T Recommendation M.3020 [5] on Guidelines for definitions of Managed Object. + +**Network Resource Model (NRM):** description of Information Object Classes representing the manageable aspects of network resources. + +NOTE 4: Examples of network resources are RNC and NodeB. + +**NRM IRP:** 3GPP publishes a number of IRP specifications each of which is related to a particular NRM (Network Resource Model) as defined in 3GPP TS 32.101 [1]. NRM IRPs do not define any operations or notifications. This term represents all such specifications. + +NOTE 5: In some NRM IRP titles, for historic reasons, they are named "...network resources IRP"). + +NOTE 6: An example of an NRM IRP is the Generic NRM IRP (32.621 [11], 32.622 [12], 32.626 [13]). + +**Solution Set (SS):** mapping of the IRP Information Service (IS) defined entities (that are technology-agnostic) to technology specific termed entities. + +NOTE 7: SS does not contain specification of the entities' semantics which can be found in the corresponding IS. One IS can be mapped to one or several SSs. + +NOTE 8: Examples of an IS defined entity and technology specific termed entity are IOC and MOC respectively. + +**SupportIOC:** representation of a particular capability, introduced to model a management service. + +NOTE 9: As an example of SupportIOC, in the Alarm IRP Information Service TS 32.111-2 [7] there are the AlarmInformation and AlarmList IOCs. + +NOTE 10: See Annex F of TS 32.156 [18] for information about the difference between IOC and SupportIOC. + +**Yyy IRP:** For a specific Interface IRP such as the Basic CM IRP, when the letters Yyy are replaced by the specific key words naming that IRP (in the given example the Yyy is replaced by "Basic CM"), this term represents all specifications that are part of that Interface IRP. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.157 [19]. + +# 4 Integration Reference Points (IRPs) + +## 4.1 Introduction + +For the purpose of management interface development 3GPP has developed an interface concept known as Integration Reference Point (IRP) to promote the wider adoption of standardized management interfaces in telecommunication networks. The IRP concept and associated methodology employs protocol and technology neutral modelling methods as well as protocol specific solution sets to achieve its goals. + +### 4.1.1 General + +The three cornerstones of the IRP concept are: + +- **Top-down, process-driven modelling approach:** The purpose of each IRP is automation of one specific task, related to TMF TOM. This allows taking a "one step at a time" approach with a focus on the most important tasks. +- **Technology-independent modelling:** To create from the requirements an interface technology independent model. This is specified in the IRP Information Service. +- **Standards-based technology-dependent modelling:** To create one or more interface technology dependent models from the technology independent model. This is specified in the IRP Solution Set(s). + +Based on above-described concept, IRP specifications are using a 3-level approach: Requirements, IS-level and SS-level. + +### 4.1.2 IRP Specifications Approach + +As highlighted in the previous subclause, IRP specifications are specified using a 3-level approach: Requirements, IS-level and SS-level. + +Furthermore, there are three categories of IRP specifications (see formal and more detailed definitions in subclause 3.1): + +- Interface IRPs, e.g. Notification IRP, ALARM IRP, etc. +- NRM IRPs, e.g. Generic NRM. +- Data Definition IRPs, e.g. State Management IRP. + +Each category is partitioned into Requirements, IS-level and SS-level specifications. + +#### Level 1: + +The "Requirements-level" intends to provide conceptual and use cases definitions for a specific management interface aspect as well as defining subsequent requirements for this IRP. + +#### Level 2: + +The "IS-level" provides the technology independent specification of an IRP. + +#### Level 3: + +The "SS-level" finally provides the mapping of IS definitions into one or more technology-specific Solution Sets. This concept provides support for multiple interface technologies as applicable on a vendor and/or network type basis and also enables accommodation of future interface technologies - without the need to redefine requirements and IS-level definitions. + +#### Usage of terms: + +The term IOC and SupportIOC are used in IS-level specification. The term MOC is used in SS-level specifications and it corresponds to IOC or SupportIOC defined in IS-level specification. This term MOC is a term defined by ITU-T M.series Recommendations. See subclause 7.3.4.3 of [5] on Guidelines for definitions of Managed Object, for information. + +## 4.2 Integration levels + +Virtually all types of telecom/datacom networks comprise many different technologies purchased from several different vendors. This implies that the corresponding management solution need to be built by integrating product-specific applications from different vendors with a number of generic applications that each provide some aspect of multi-vendor and/or multi-technology support. A complete management solution is thus composed of several independent applications. + +The following levels of integration are defined: + +- **Screen Integration:** Each application provides its own specific Graphical User Interface (GUI) that need to be accessible from a single, unified screen (a common desktop). A seamless integration between the various GUIs is then required. Screen Integration is not specified in the present document. +- **Application Integration:** Applications need to interwork, on a machine-machine basis, in order to automate various end-to-end processes of a communication provider. + +### 4.2.1 Application integration + +Interfaces related to application integration can be divided in the following three categories: + +- 1) **High-level generic interfaces:** between generic applications on the network and service management layers. The same approach and concepts apply for these as the next category. +- 2) **High-level (technology-independent to the extent possible) interfaces:** between product-specific and generic applications are needed in order to automate and streamline frequently occurring tasks applicable to several types of network elements. A top-down approach shall be taken when defining these interfaces, where the main input is: + - a) business processes of a communication provider; and + - b) the types of generic applications that are used to implement the process support. +- 3) **Detailed (product-specific) interfaces:** between product-specific applications and the corresponding network elements are of course also needed. These interfaces are defined using the traditional bottom-up approach, where the actual network infrastructure is modelled. This is the traditional TMN approach to element management. The management information in these interfaces is not further discussed in the present document, as it is internal to a specific development organization and does not need to be open. In fact, by publishing the management information in these interfaces, too much of the internal design may be revealed and it may become impossible to later enhance the systems that are using the interfaces. The management services (operations and notifications) and protocol shall however be open and standardized as long as they are independent of the NRM describing the managed NEs/NRs. + +## 4.3 Application of IRPs + +When providing integrated management solutions for multi-vendor networks, there is a strong requirement that the NEs and the management solutions that go together with them are systems integratable. + +It should be noted that these IRPs could be provided by an IRP Agent on any management interface. + +These IRPs are introduced to ensure interoperability, for example between Product-Specific Applications (PSA) and the Network and System Management Processes (SMP) of the Network Manager (NM) - see figure 4.3 from TS 32.101 [1]. These IRPs are considered to cover the most basic needs of task automation. + +![Figure 4.3: Examples of IRPs for application integration. The diagram shows a Network Manager at the top containing five Network & System Management Processes: Network Planning & Development, Network Inventory Management, Network Provisioning, Network Maintenance & Restoration, and Network Data Management. Below the Network Manager is a cloud representing the network environment, containing an Element Manager, a Product Specific Application (PSA), and Network Elements (NE). Arrows indicate the flow of Information Resource Protocols (IRPs) between the Network Manager processes and the PSA/Element Manager. The IRPs are categorized: Service IRPs (red), CM IRPs (Bulk, Inventory, State....) (purple), Common IRPs (Notification, File Xfer, Log...) (black), FM IRPs (Alarm, Test..) (green), and PM IRPs (blue). On the left, two alternative IRPs are shown between the PSA and the NE. A legend at the bottom right defines PSA as Product Specific Application and NE as Network Element.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +Figure 4.3: Examples of IRPs for application integration. The diagram shows a Network Manager at the top containing five Network & System Management Processes: Network Planning & Development, Network Inventory Management, Network Provisioning, Network Maintenance & Restoration, and Network Data Management. Below the Network Manager is a cloud representing the network environment, containing an Element Manager, a Product Specific Application (PSA), and Network Elements (NE). Arrows indicate the flow of Information Resource Protocols (IRPs) between the Network Manager processes and the PSA/Element Manager. The IRPs are categorized: Service IRPs (red), CM IRPs (Bulk, Inventory, State....) (purple), Common IRPs (Notification, File Xfer, Log...) (black), FM IRPs (Alarm, Test..) (green), and PM IRPs (blue). On the left, two alternative IRPs are shown between the PSA and the NE. A legend at the bottom right defines PSA as Product Specific Application and NE as Network Element. + +**Figure 4.3: Examples of IRPs for application integration** + +Taking one of the above mentioned IRPs as an example, the Network and System Management Processes have similar need to receive notifications from various PSAs. The corresponding service is formalized as a *Notification IRP*. It specifies: firstly, an interface through which subscriptions to different types of notifications can be set-up (or cancelled), and secondly, common attributes for all notifications. + +Further, applying a common *Name Convention for Managed Objects* is useful for co-operating applications that require identical interpretation of names assigned to network resources under management. + +## 4.4 Defining the IRPs + +It is important to accommodate more than one specific technology, as the technologies will change over time. Applications need to be future-proof. One fundamental principle for achieving this is to clearly separate the semantics of information definition from the protocols definitions (accessing the information) for the external interfaces. + +The framework being used to define IRPs allows the implementation of user requirements for each management capability (e.g. configuration management), by modelling the information related to the resources to be managed and the way that the information may be accessed and manipulated. Such modelling is done in a way that is independent of the technology and distribution used in the implementation of a management system. + +The IRP methodology uses the following steps: + +- Capture the management requirements. +- Specify the semantics of the information to describe the system. Trace back to item (a). +- Specify the semantics of the interactions between the management system and its clients. Trace back to item (a). +- Specify the syntaxes of the information and interactions identified in (b) and (c). The specification is technology dependent. Trace back to items (b) and (c). + +Figure 4.4 shows an example of how an IRP can be structured (the Alarm IRP). + +![Diagram of the Alarm IRP structure showing layers from Requirements down to Network Layer, separated into Protocol Independent and Protocol Specific sections.](fbfa653853daf5541118a9ddecb92284_img.jpg) + +| | | | | +|-----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|--------------------------------------------------------------|-------------------------------| +| Alarm IRP: Requirements | | | Requirements | +| Alarm IRP: Information Service | | | Information Service | +| Notifications for Alarm reporting and operations possible over the Alarm IRP (Specified in UML and natural language). | | | | +|
| | | Protocol independent ↔ | +|
| | | Protocol specific ↔ | +| SNMP Solution Set | CORBA Solution Set | CMIP Solution Set | Solution Set Layer | +| Alarm IRP mapped to SNMP including standard SNMP MIB:s | Alarm IRP mapped to CORBA IDL files. Alarm reporting mapped to OMG Structured events. | Alarm IRP mapped to GDMO including relevant ITU-T standards. | | +|
| | | | +| SNMP | CORBA/IIOP | CMIS | Application Layer | +| | | CMIP | | +|
| | | | +| UDP | TCP | OSI transport protocol | Transport Layer | +|
| | | | +| IP | | OSI network protocol | Network Layer | + +Diagram of the Alarm IRP structure showing layers from Requirements down to Network Layer, separated into Protocol Independent and Protocol Specific sections. + +Figure 4.4: Example of an IRP (Alarm IRP) + +## 4.5 Void + +## 4.6 Mandatory, Optional and Conditional qualifiers + +Note: Void. + +This subclause defines a number of terms used to qualify the relationship between the Information Service, the Solution Sets and their impact on the IRP implementations. The qualifiers defined in this clause are used to qualify IRP Agent behaviour only. This is considered sufficient for the specification of the IRPs. + +Additional qualifier definitions are specified in 3GPP TS 32.156 “Model Repertoire” [18]. + +IS specifications define IOC attributes, interfaces, operations, notifications, operation parameters and notification parameters. They can have the following support/read/write qualifiers: M, O, CM, CO, C. + +Definition of qualifier M (Mandatory): + +- Used for items that shall be supported. + +Definition of qualifier O (Optional): + +- Used for items which may or may not be supported. + +Definition of qualifier CM (Conditional-Mandatory): + +- Used for items that are mandatory under certain conditions, specifically: + - All items having the support qualifier CM shall have a corresponding constraint defined in the IS specification. If the specified constraint is met then the items shall be supported. Definition of qualifier CO (Conditional-Optional): +- Used for items that are optional under certain conditions, specifically: + - All items having the support qualifier CO shall have a corresponding constraint defined in the IS specification. If the specified constraint is met, then the items may be supported. + +Definition of qualifier C (SS-Conditional): + +- Used for items that are only applicable for certain but not all Solutions Sets (SSs). + +SS specifications define the SS-equivalents of the IS-defined IOC attributes, operations, notifications, operation parameters and notification parameters. These SS-equivalents can have the following support/read/write qualifiers: M, O, CM and CO. + +The mapping of the qualifiers of IS-defined constructs to the qualifiers of the corresponding SS-constructs is defined as follows: + +- For qualifier M, O, CM and CO, each IS-defined item (operation and notification, input and output parameter of operations, input parameter of notifications, information relationship and information attribute) shall be mapped to its equivalent(s) in all SSs. Mapped equivalent(s) shall have the same qualifier as the IS-defined qualifier. +- For qualifier C, each IS-defined item shall be mapped to its equivalent(s) in at least one SS. Mapped equivalent(s) can have support qualifier M or O. + +Table 4.6 defines the semantics of qualifiers of the Interface IRP SS equivalents, in terms of support from the IRP Agent perspective. + +**Table 4.6: Semantics for Mandatory, Optional and Conditional qualifiers used in Solution Sets** + +| Mapped SS Equivalent | Mandatory | Optional | Conditional-Mandatory (CM) | Conditional-Optional (CO) | +|-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Mapped notification equivalent | The IRP Agent shall generate the notification. | The IRP Agent may or may not generate it. | The IRP Agent shall generate this notification if the constraint described in the IS for this item is satisfied. | The IRP Agent may choose whether or not to generate it. If the IRP Agent chooses to generate it, the constraint described in the IS for this notification must be satisfied. | +| Mapped operation equivalent | The IRP Agent shall support it. | The IRP Agent may or may not support this operation. If the IRP Agent does not support this operation, the IRP Agent shall reject the operation invocation with a reason indicating that the IRP Agent does not support this operation. The rejection, together with a reason, shall be returned to the IRP Manager. | The IRP Agent shall support this operation if the constraint described in the IS for this item is satisfied. | The IRP Agent may support this operation if the constraint described in the IS for this item is satisfied. | +| Input parameter of the mapped operation equivalent | The IRP Agent shall accept and behave according to its value. | The IRP Agent may or may not support this input parameter. If the IRP Agent does not support this input parameter and if it carries meaning (i.e. it does not carry no-information semantics), the IRP Agent shall reject the invocation with a reason (that it does not support the parameter). The rejection, together with the reason, shall be returned to the IRP Manager. | The IRP Agent shall accept and behave according to its value if the constraint described in the IS for this item is satisfied. | The IRP Agent may accept and behave according to its value if the constraint described in the IS for this item is satisfied. | +| Input parameter of mapped notification equivalent AND output parameter of mapped operation equivalent | The IRP Agent shall supply this parameter. | The IRP Agent may supply this parameter. | The IRP Agent shall supply this parameter if the constraint described in the IS for this item is satisfied. | The IRP Agent may supply this parameter if the constraint described in the IS for this item is satisfied. | +| Mapped IOC attribute equivalent | The IRP Agent shall support it. | The IRP Agent may support it. | The IRP Agent shall support this attribute if the constraint described in the IS for this item is satisfied. | The IRP Agent may support this attribute if the constraint described in the IS for this item is satisfied. | + +## 4.7 System context for Interface IRPs + +Every Interface IRP on a management interface (e.g. Alarm IRP, Notification IRP, Basic CM IRP, Bulk CM IRP) is subject to a System Context as described in this subclause (also consistent with 3GPP TS 32.102 [2] clause 8). + +Figure 4.7.1 and 4.7.2 identify system contexts of the Interface IRP in terms of its implementation, called IRPAgent, and the user of the IRPAgent, called IRPManager. + +Each IRPAgent implements and supports one or more IRPs. The set of IRPs that is related to each Interface IRP is defined by the System Context subclause in each individual Interface IRP IS specification, e.g. subclause 4.2 in the Alarm IRP IS [7]. + +An NE can be managed via System Context A or B. The criterion for choosing System Context A or B to manage a particular NE is implementation dependent. An IRPAgent shall support one of the two System Contexts. By observing the interaction across the management interface, an IRPManager cannot deduce if the EM and NE are integrated in a single system or if they run in separate systems. + +![Figure 4.7.1: System Context A diagram](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +The diagram illustrates System Context A. On the left, a box labeled 'NM' contains a sub-box labeled 'IRPManager'. On the right, a box labeled 'EM' contains a sub-box labeled 'IRPAgent'. A solid horizontal line connects the 'IRPManager' and the 'IRPAgent'. A vertical dashed line separates the NM and EM boxes, representing the 'management interface (e.g. Itf-N)'. To the right of the EM box, a dotted line connects the 'IRPAgent' to a box labeled 'NEs'. Below the EM box, a bracket labeled 'Supported IRP(s)' points to the 'IRPAgent' box. A curved arrow points from the 'management interface' label to the vertical dashed line. + +Figure 4.7.1: System Context A diagram + +Figure 4.7.1: System Context A + +![Figure 4.7.2: System Context B diagram](70de8885bd7de15723aaad5eb5c5febf_img.jpg) + +The diagram illustrates System Context B. On the left, a box labeled 'NM' contains a sub-box labeled 'IRPManager'. On the right, a box labeled 'NE' contains a sub-box labeled 'IRPAgent'. A solid horizontal line connects the 'IRPManager' and the 'IRPAgent'. A vertical dashed line separates the NM and NE boxes, representing the 'management interface (e.g. Itf-N)'. Below the NE box, a bracket labeled 'Supported IRP(s)' points to the 'IRPAgent' box. A curved arrow points from the 'management interface' label to the vertical dashed line. + +Figure 4.7.2: System Context B diagram + +Figure 4.7.2: System Context B + +An entity can play the consumer role for some operations/notifications and the producer role for other operations/notifications of the same Interface IRP. A diagram shall contain the direction of the operations and notifications per operation and notification. + +Examples of when the entities can play the role of both consumer and producer are depicted in Figures 4.7.3. + +![Diagram illustrating entities X and Y with multiple roles (Consumer and Producer) connected via a management interface (e.g., Itf-N). Entity X contains a Consumer and a Producer. Entity Y contains a Producer and a Consumer. Arrows show interactions: X's Consumer connects to Y's Producer, and X's Producer connects to Y's Consumer. Curved arrows point from Y's Producer and Y's Consumer to text blocks describing supported interfaces.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +The diagram shows two entities, X and Y, separated by a vertical dashed line representing a management interface (e.g., Itf-N). Entity X contains two sub-components: a Consumer and a Producer. Entity Y also contains two sub-components: a Producer and a Consumer. A horizontal arrow points from the Consumer in X to the Producer in Y. Another horizontal arrow points from the Producer in X to the Consumer in Y. A curved arrow originates from the Producer in Y and points to a text block: "Supported Interface IRP Operation 1 and 3 Notification A". Another curved arrow originates from the Consumer in Y and points to a text block: "Supported Interface IRP Operation 2 Notification B". The text "management interface (e.g. Itf-N)" is positioned below the dashed line. + +Diagram illustrating entities X and Y with multiple roles (Consumer and Producer) connected via a management interface (e.g., Itf-N). Entity X contains a Consumer and a Producer. Entity Y contains a Producer and a Consumer. Arrows show interactions: X's Consumer connects to Y's Producer, and X's Producer connects to Y's Consumer. Curved arrows point from Y's Producer and Y's Consumer to text blocks describing supported interfaces. + +Figure 4.7.3: Example for entities that can have several roles + +## 4.8 Object instance visibility + +Via the management interface, IRP Agent provides IRP Manager visibility of the various object instances, i.e. the information captured by various IOC instances can be passed between IRP Manager and IRP Agent. See Annex F of [18]. + +# --- Annex A (informative): Void + +# --- Annex B (normative): Void + +--- + +Annex C (informative): +Void + +--- + +Annex D (informative): +Void + +--- + +Annex E (normative): +Void + +--- + +Annex F (informative): +Void + +# Annex G (normative): IOC Properties and Inheritance + +## G.1 Property + +The properties of an IOC (including SupportIOC) are specified in terms of the following: + +- a) An IOC attribute(s) including its semantics and syntax, its legal value ranges and support qualifications. The IOC attributes are not restricted to Configuration Management but also include those related to, for example, 1) Performance Management (i.e., measurement types), 2) Trace Management and 3) Accounting Management. +- b) The non-attribute-specific behaviour associated with an IOC (see Note 1). + +NOTE 1: As an example, the Link between MscServerFunction and CsMgwFunction is optional. It is mandatory if the MscServerFunction instance belongs to one ManagedElement instance while the CsMgwFunction instance belongs to another ManagedElement instance. This Link behaviour is a non-attribute-specific behaviour. It is expected that this behaviour, like others, will be inherited. + +- c) An IOC relationship(s) with another IOC(s). +- d) An IOC notification type(s) and their qualifications. +- e) An IOC's relation with its parents (see Note 2). There are three mutually exclusive cases: + - 1) The IOC can have any parent. In UML diagram, the class has a parent *Any*. + - 2) The IOC is abstract and all of the possible parent(s) have been designated and whether subclass IOCs can be designated as a root IOC. In UML diagram, the class has zero or more possible parents of specific classes (except *Any*) . + - 3) The IOC is concrete and all of the possible parent(s) have been designated and whether the IOC can be designated as a root IOC. In UML diagram, the class has one or more possible parents of specific classes (except *Any* . ) + +An IOC instance is either a root IOC or it has one and only one parent. Only 3GPP SA5 may designate an IOC class as a potential root IOC. Currently, only SubNetwork, ManagedElement or MeContext IOCs can be root IOCs. + +NOTE 2: The parent and child relation in this clause is the parent name-containing the child relation. + +- f) An IOC's relation with its children. There are three mutually exclusive cases: + - 1) An IOC shall not have any children (name-containment relation) IOCs. In UML diagram, the class has no child. + - 2) An IOC can have children IOC(s). The maximum number of instances per children IOC (including their subclasses) can be specified. An IOC may designate that vendor specific objects are not allowed as children IOCs. In UML diagram, the class has a child *Any* . + - 3) An IOC can only have the specific children IOC(s) (or their subclasses). The maximum number of instances per children IOC (including their subclasses) can be specified. An IOC may designate that vendor specific objects are not allowed as children IOCs. In UML diagram, the class has one or more children of specific classes (except *Any*) . +- g) Whether An IOC can be instantiated or not (i.e., whether An IOC is an abstract IOC). +- h) An attribute for naming purpose. + +## G.2 Inheritance + +An IOC (the subclass) inherits from another IOC (the superclass) in that the subclass shall have all the properties of the superclass. + +The subclass can change the inherited support-qualification(s) from optional to mandatory but not vice versa. The subclass can change the inherited support-qualification from conditional-optional to conditional-mandatory but not vice versa. + +An IOC can be a superclass of many IOC(s). A subclass cannot have more than one superclass. + +The subclass can: + +- a) Add (compared to those of its superclass) unique attributes including their behaviour, legal value ranges and support-qualifications. Each additional attribute shall have its own unique attribute name (among all added and inherited attributes). +- b) Add non-attribute behaviour on an IOC basis. This behaviour may not contradict inherited superclass behaviour. +- c) Add relationship(s) with IOC(s). Each additional relationship shall have its own unique name (among all added and inherited relations). +- d) Add additional notification types and their qualifications. +- e) Designate all of the possible parent(s) (and their subclasses) if the superclass has Property-e-1 such that an IOC will have Property-e-2 or Property-e-3. Restrict possible parent(s) (and their subclasses) and/or remove the capability of the subclass from being a root IOC, if the superclass has Property-e-2 or Property-e-3. +- f) Add children IOC(s) if the superclass has Property-f-2 such that an IOC will have Property-f-3. Restrict the allowed children IOC(s) (or their subclasses) if the superclass has Property-f-3. +- g) Specify whether an IOC can be instantiated or not (i.e. the IOC is an abstract IOC). +- h) Restrict the legal value range of a superclass attribute that has a legal value range. + +# --- Annex H (normative): Interface Properties and Inheritance + +## H.1 Property + +To be defined. + +## --- H.2 Inheritance + +To be defined. + +# --- Annex I (normative): Entity (Interface, IOC and Attribute) Import + +IRP specifications define entities(e.g., IOCs, interfaces and attribute). To facilitate re-use of entity definitions among IRP specifications, an import mechanism is used. When an IRP specification (the subject IRP specification) imports an entity defined in another IRP specification, the subject IRP specification is considered to have defined the imported entity in its specification. Furthermore, the subject IRP specification cannot change the properties of this imported entity. If it requires an entity that is not identical but similar to the imported entity, it should define a new entity that inherits the imported entity and introduce changes in the new entity definition. \ No newline at end of file diff --git a/marked/Rel-18/32_series/32155/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32155/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4de7dd97b9337b3aaf072e746405ad520d5d45de --- /dev/null +++ b/marked/Rel-18/32_series/32155/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b42d116d8c2d814c86377d52a84e0f5d4ef04fd6b66457e5edf7e3dd2ea4cb7 +size 9370 diff --git a/marked/Rel-18/32_series/32155/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32155/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..befa7d0aab7a27d907df9a48accf6d9115609306 --- /dev/null +++ b/marked/Rel-18/32_series/32155/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9faff289c269ff2b0f41d2267933e4cc43c36969d345e79d9a3b32ee4d7b5dbd +size 5420 diff --git a/marked/Rel-18/32_series/32155/raw.md b/marked/Rel-18/32_series/32155/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..948bb8dbd716bef98b2bc400de1b46c4b34acc87 --- /dev/null +++ b/marked/Rel-18/32_series/32155/raw.md @@ -0,0 +1,207 @@ + + +# 3GPP TS 32.155 V18.0.0 (2024-04) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Requirements template (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +GSM, UMTS, 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. + +© 2024, 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 ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 Requirements template..... | 6 | +| 4.0 General ..... | 6 | +| 4.1 Template for high-level Requirements TSs ..... | 6 | +| 4.2 Template for Integration Reference Point (IRP) specific Requirements TSs ..... | 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 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 32.150: Integration Reference Point (IRP) Concept and definitions; +- TS 32.153: Integration Reference Point (IRP) technology specific templates; +- TS 32.154: Backward and Forward Compatibility (BFC); Concept and definitions; +- TS 32.155: Requirements template;** +- TS 32.156: Telecommunication management; Fixed Mobile Convergence (FMC) Model Repertoire. +- TS 32.157: Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template. + +# --- 1 Scope + +The present document contains the template to be used for the production of all IRP based requirements TSs for the 3GPP Telecommunication management. + +This template is mainly based on the requirements template (mainly Annex A) in the ITU-T M.3020 recommendation [6]. + +# --- 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] Void. +- [6] ITU-T Recommendation M.3020 (07/2011): "Management interface specification methodology". +- [7] 3GPP TS 32.761: "E-UTRAN Network Resource Model (NRM) IRP; Requirements". +- [8] Void. +- [9] 3GPP TS 32.157: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template". + +# --- 3 Definitions, 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 [4], TS 32.157[9] 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], TS 32.101 [2], TS 32.102 [3], 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]. + +| | | +|-----|-----------------------------| +| IRP | Integration Reference Point | +| IS | Information Service | + +# --- 4 Requirements template + +## 4.0 General + +This template is mainly based on the requirements template (mainly Annex A) in the ITU-T M.3020 recommendation [6], and shall be used for the production of all Requirements TSs for the 3GPP Telecommunication management. The template contains two options: Option 1 specified in subclause 4.1, which shall be used for all high-level Requirements TSs for the 3GPP Telecommunication management, and option 2 specified in subclause 4.2, which shall be used for all Integration Reference Point (IRP) specific Requirements TSs such as 3GPP TS 32.761 [7]. + +Instructions in *italics* below shall not be included in the Requirements TS. + +The introductory clauses (from clause 1 to clause 3) for the Requirements TS should be taken from the 3GPP TS template (i.e. not this requirements template) – see [http://www.3gpp.org/ftp/Information/TS\\_TR\\_Templates/](http://www.3gpp.org/ftp/Information/TS_TR_Templates/). + +Use the "Heading 1" paragraph style for clause 4, 5 and 6 in the Requirements TS. + +Usage of fonts shall be according to the 3GPP TS template. + +## 4.1 Template for high-level Requirements TSs + +### --- 4 Concepts and background + +*For production of the contents of this clause, follow the template instructions in ITU-T M.3020 [6] subclause A.2, template clause "1 Concepts and background".* + +### --- 5 Business level requirements + +*For production of the contents of this subclause, follow the template instructions in ITU-T M.3020 [6] subclause A.2, template clause "2 Business level requirements".* + +*Note on the Use case template: All occurrences of "(\*)" in the first column "Use Case Stage" of the Use case template in table A.2, as well as the last row with a NOTE at the end of the table, shall not be included in the requirements TS as these are only template instructions to the TS author. For example, "Goal(\*)" shall be converted to "Goal" in the TS. Likewise, for all occurrences of "(M|O)", a choice of M or O shall be made, leaving it as either "(M)" or "(O)" in the TS. For example, "Step n (M|O)" shall be converted to "Step n (M)" or "Step n (O)" in the TS.* + +### --- 6 Specification level requirements + +*For production of the contents of this subclause, follow the template instructions in ITU-T M.3020 [6] subclause A.2, template clause "3 Specification level requirements".* + +*Note on the Use case template: All occurrences of "(\*)" in the first column "Use Case Stage" of the Use case template in table A.2, as well as the last row with a NOTE at the end of the table, shall not be included in the requirements TS as these are only template instructions to the TS author. For example, "Goal(\*)" shall be converted to "Goal" in the TS. Likewise, for all occurrences of "(M|O)", a choice of M or O shall be made, leaving it as either "(M)" or "(O)" in the TS. For example, "Step n (M|O)" shall be converted to "Step n (M)" or "Step n (O)" in the TS.* + +### 4.2 Template for Integration Reference Point (IRP) specific Requirements TSs --- + +### 4 Concepts and background + +*For production of the contents of this clause, follow the template instructions in ITU-T M.3020 [6] subclause A.3, template clause "1 Concepts and background".* + +--- + +# 5 Requirements + +*For production of the contents of this subclause, follow the template instructions in ITU-T M.3020 [6] subclause A.3, template clause "2 Requirements".* + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|------|-----|--------------------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| Jun 2008 | SA_40 | SP-080329 | 0001 | - | Correct the clause references to ITU-T Recommendation M.3020 | F | 8.0.0 | 8.1.0 | +| Dec 2008 | SA_42 | SP-080846 | 0002 | - | Simplified requirements template for IRPs | F | 8.1.0 | 8.2.0 | +| Mar 2009 | SA-43 | SP-090207 | 0003 | -- | Simplified requirements template for IRPs | F | 8.2.0 | 8.3.0 | +| Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.3.0 | 9.0.0 | +| Mar 2011 | - | - | - | - | 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-10 | - | - | - | - | Update to Rel-12 version (MCC) | - | 11.0.0 | 12.0.0 | +| 2014-12 | SA-66 | SP-140799 | 0004 | 1 | Upgrade M3020 reference and template instructions | C | 12.0.0 | 13.0.0 | +| 2015-01 | - | - | - | - | Editorial corrections in indentation of 4.1 and 4.2 (MCC) | - | 13.0.0 | 13.0.1 | +| 2015-03 | SA-67 | SP-150061 | 0005 | - | Editorial corrections | D | 13.0.1 | 13.1.0 | + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------|---------------|--| +| Date | Meeting | Tdoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2016-12 | | | | | | Correction of LTE logo (MCC) | 13.1.1 | | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | | +| 2018-01 | SA#78 | SP-170964 | 0006 | - | F | 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 | | +| 2022-03 | - | - | - | - | - | Update to Rel-17 version (MCC) | 17.0.0 | | +| 2022-12 | SA#98e | SP-221170 | 0008 | - | A | Correction of scope | 17.1.0 | | +| 2024-04 | - | - | - | - | - | Update to Rel-18 version (MCC) | 18.0.0 | | \ No newline at end of file diff --git a/marked/Rel-18/32_series/32156/04f51626e2e10a16e3eb2c4b33cb2742_img.jpg b/marked/Rel-18/32_series/32156/04f51626e2e10a16e3eb2c4b33cb2742_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f166d8796942e97ede29ae1645a50fc15d53ccb6 --- /dev/null +++ b/marked/Rel-18/32_series/32156/04f51626e2e10a16e3eb2c4b33cb2742_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2bece6e1640f1004f671135f15c9db424603b0a6748830176d75f369424fa9bd +size 12830 diff --git a/marked/Rel-18/32_series/32156/08c7a76a7786bd08b99dd4cb41583ef4_img.jpg b/marked/Rel-18/32_series/32156/08c7a76a7786bd08b99dd4cb41583ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..70dbbebfd19aa7d4a69e91b6f278aaa445a25af1 --- /dev/null +++ b/marked/Rel-18/32_series/32156/08c7a76a7786bd08b99dd4cb41583ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:636b45db55584c26a6f1517b15495330ad818948c89d3d843a15206f520b9d06 +size 44080 diff --git a/marked/Rel-18/32_series/32156/2834bdd6eb8540277e609decbb924003_img.jpg b/marked/Rel-18/32_series/32156/2834bdd6eb8540277e609decbb924003_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f98b6d664c8d2b441167b50a1dca85586ff87276 --- /dev/null +++ b/marked/Rel-18/32_series/32156/2834bdd6eb8540277e609decbb924003_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:76cb3b75a80568d3cc99db5d65fcb2669fc34d495afd4978fea01e52e2c7d818 +size 5688 diff --git a/marked/Rel-18/32_series/32156/2837ffdadcdb1e5bababa56b564e56ed_img.jpg b/marked/Rel-18/32_series/32156/2837ffdadcdb1e5bababa56b564e56ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f455b7c29fbf953f2be6efa62b8e47938d7ea6de --- /dev/null +++ b/marked/Rel-18/32_series/32156/2837ffdadcdb1e5bababa56b564e56ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d34a0d27a001500ca86ecd9ff13e4e30e7ee0100ecf59c287819a84c5548ca5c +size 95347 diff --git a/marked/Rel-18/32_series/32156/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-18/32_series/32156/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b34eb1cc84f4e71df09bdaff4e7c1e7fb020864d --- /dev/null +++ b/marked/Rel-18/32_series/32156/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b8f5b8768f83530abe91b34357ad1c2fab2066904ffa42d4cf04697ea7cd4ac6 +size 27831 diff --git a/marked/Rel-18/32_series/32156/356eb99ab9489bbd647223390a913903_img.jpg b/marked/Rel-18/32_series/32156/356eb99ab9489bbd647223390a913903_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c2261419297e9bff32e7aca8feac0f73180fecec --- /dev/null +++ b/marked/Rel-18/32_series/32156/356eb99ab9489bbd647223390a913903_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:743bfadcf5017b10e0e225cb7ef158178700977b71b5aabb8aac5ca5858f82ac +size 30887 diff --git a/marked/Rel-18/32_series/32156/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg b/marked/Rel-18/32_series/32156/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8638220bfbf985e5f99ce40668a5dc035bb62d86 --- /dev/null +++ b/marked/Rel-18/32_series/32156/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f81de31d4cd34233098f9174950f94ed752bc62d7d56329c68854079174e312e +size 19616 diff --git a/marked/Rel-18/32_series/32156/409498e57b1f988b2b604d12cd997002_img.jpg b/marked/Rel-18/32_series/32156/409498e57b1f988b2b604d12cd997002_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2df73dddf70d22958f3d593383d414d9817451ea --- /dev/null +++ b/marked/Rel-18/32_series/32156/409498e57b1f988b2b604d12cd997002_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a584036eaf35ae8e74a0ff8bf0448d27f23b4bc3c5a1aff74bc2cc599734033f +size 4900 diff --git a/marked/Rel-18/32_series/32156/4356776ca004ecba5d599667a155d7d4_img.jpg b/marked/Rel-18/32_series/32156/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b22e2139e53a02a157e9a0ccd96dc1fb2836f58 --- /dev/null +++ b/marked/Rel-18/32_series/32156/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45250daf4168c5505ccf74829986abfff3c9c75568d710d42834a7653467282d +size 13475 diff --git a/marked/Rel-18/32_series/32156/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-18/32_series/32156/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9edb7204256b57c4df94b93a9980808864549076 --- /dev/null +++ b/marked/Rel-18/32_series/32156/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8a902b0df9d0e0621330b4be4cfe04ed4571098e548ab090b90b85c5157b4b3 +size 7685 diff --git a/marked/Rel-18/32_series/32156/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg b/marked/Rel-18/32_series/32156/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a5fdea7803db992cf944f4a9c330319634bb04dc --- /dev/null +++ b/marked/Rel-18/32_series/32156/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ad254d0714e69a8a08f8da932f3d05bdfdfafac39ffd396b5eb0c38179767b1 +size 6690 diff --git a/marked/Rel-18/32_series/32156/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32156/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..171f8ad16167c0661d30ba22d3434bb16dcce2c8 --- /dev/null +++ b/marked/Rel-18/32_series/32156/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4cac85760b5c814c16f952b021d435921cbae0479cbed6d788f85c2202c61611 +size 9735 diff --git a/marked/Rel-18/32_series/32156/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32156/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..248fdcfd81c8742d7ccfe78b179f98d62f269470 --- /dev/null +++ b/marked/Rel-18/32_series/32156/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6414a0765a8c4ca4d92c242268dbf81a6b7454b63f33b1197d4fb2e1edd35033 +size 5171 diff --git a/marked/Rel-18/32_series/32156/70de8885bd7de15723aaad5eb5c5febf_img.jpg b/marked/Rel-18/32_series/32156/70de8885bd7de15723aaad5eb5c5febf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88391e46f2fab7cb906f412cd0f627499d0767c4 --- /dev/null +++ b/marked/Rel-18/32_series/32156/70de8885bd7de15723aaad5eb5c5febf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:893a90273d66c7b000ccd5ada2a84bb868cd7f448369bef481da77cc0da4b7f7 +size 14642 diff --git a/marked/Rel-18/32_series/32156/73b706c7393e92b17699c773f18918ff_img.jpg b/marked/Rel-18/32_series/32156/73b706c7393e92b17699c773f18918ff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93f08f41c121d9626a8f2054c82920ae63597483 --- /dev/null +++ b/marked/Rel-18/32_series/32156/73b706c7393e92b17699c773f18918ff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48e4cf4ed9adc6166184ecd35155b32d4942a934075292fa08f6855729d365cd +size 11500 diff --git a/marked/Rel-18/32_series/32156/7728e2dd44c95d109debb1eb59e9b411_img.jpg b/marked/Rel-18/32_series/32156/7728e2dd44c95d109debb1eb59e9b411_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..241bc29af45bfea57b7ee59631f233eed486ed1b --- /dev/null +++ b/marked/Rel-18/32_series/32156/7728e2dd44c95d109debb1eb59e9b411_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:471517f9ae6abee8eb6fd345aaad3f75a1271ee8836e3ed2637d657d7a0c1ca2 +size 13625 diff --git a/marked/Rel-18/32_series/32156/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg b/marked/Rel-18/32_series/32156/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ead8c4ea99d815f8f78b8d58a8a2ea2685435fda --- /dev/null +++ b/marked/Rel-18/32_series/32156/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc341760301017577a8643a68a26cdd9994293503dbc19069ee694f6ff1f255c +size 37257 diff --git a/marked/Rel-18/32_series/32156/86b4670fc1a5a694821ee92b99c1209a_img.jpg b/marked/Rel-18/32_series/32156/86b4670fc1a5a694821ee92b99c1209a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1ddd9ffe31a486f7a985ada0e02d028c09028053 --- /dev/null +++ b/marked/Rel-18/32_series/32156/86b4670fc1a5a694821ee92b99c1209a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d7ee73b3d31e32dadb5e5cccc927ff2e696b71d656be2047a047ceb155615417 +size 11898 diff --git a/marked/Rel-18/32_series/32156/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg b/marked/Rel-18/32_series/32156/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c00abedf526d95cf64ca93d5dcd7051effe1a150 --- /dev/null +++ b/marked/Rel-18/32_series/32156/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7fcb1e96359a5bda28a73a30dcbf68798a49ef5c92c22e0dc846edcae2dec576 +size 16060 diff --git a/marked/Rel-18/32_series/32156/94fd137860c16c8dfd75512f10161fe8_img.jpg b/marked/Rel-18/32_series/32156/94fd137860c16c8dfd75512f10161fe8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cd50d4691bd51a9cb7be903e6964c5198fa77a53 --- /dev/null +++ b/marked/Rel-18/32_series/32156/94fd137860c16c8dfd75512f10161fe8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa0524e5588da931143e6fbcd74f6b90f07f8e369455a1c5b1322dbab8dabb1d +size 17605 diff --git a/marked/Rel-18/32_series/32156/96b0240f56d14453b5da05ec30fd5c6e_img.jpg b/marked/Rel-18/32_series/32156/96b0240f56d14453b5da05ec30fd5c6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..31b120fa53e60382e273f13d10cfa3f103e331b5 --- /dev/null +++ b/marked/Rel-18/32_series/32156/96b0240f56d14453b5da05ec30fd5c6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8c8f3d5cda5ffebf12725376e152edc4802419a30e23dd81dd465d589ee2ebf +size 12288 diff --git a/marked/Rel-18/32_series/32156/9a159e2112eac7be06bdb97e84a0c49a_img.jpg b/marked/Rel-18/32_series/32156/9a159e2112eac7be06bdb97e84a0c49a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..616af33a5b2c6c823c3c7062111b86f741275015 --- /dev/null +++ b/marked/Rel-18/32_series/32156/9a159e2112eac7be06bdb97e84a0c49a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:702dd0b020370c91c2bbb11063c247f5bea9a9091e1cf217849ab3a0e0d1b502 +size 8946 diff --git a/marked/Rel-18/32_series/32156/9db324c513563a95ae55c77f4462a969_img.jpg b/marked/Rel-18/32_series/32156/9db324c513563a95ae55c77f4462a969_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a9fc9a2b0650cd0254b834123c38507be02747f --- /dev/null +++ b/marked/Rel-18/32_series/32156/9db324c513563a95ae55c77f4462a969_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:94a076d56e6d6477e4acaf4dfca22afcc4ee53a93ae00f744eec72d944c08c6e +size 11799 diff --git a/marked/Rel-18/32_series/32156/9ff1b32449ea068bba9647d71904bd59_img.jpg b/marked/Rel-18/32_series/32156/9ff1b32449ea068bba9647d71904bd59_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d24a8fcc37e2f070f406de58567ae8009ba400da --- /dev/null +++ b/marked/Rel-18/32_series/32156/9ff1b32449ea068bba9647d71904bd59_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1e36e1a6035ecda92edff5b799228ae46b807aa9e064e8b31b8410accafcd988 +size 60085 diff --git a/marked/Rel-18/32_series/32156/a6cf7c02a60c336e0934b5ea40e35b49_img.jpg b/marked/Rel-18/32_series/32156/a6cf7c02a60c336e0934b5ea40e35b49_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d42394bfd9c0dd3968080f8db3c6e30c6b224e6 --- /dev/null +++ b/marked/Rel-18/32_series/32156/a6cf7c02a60c336e0934b5ea40e35b49_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e6672c1d45b1e7c0f5b95601041fc090c0d7906dff816b6a23de884fc3990cf +size 12451 diff --git a/marked/Rel-18/32_series/32156/b0d4609bc46c2d88a8318706bb5321f7_img.jpg b/marked/Rel-18/32_series/32156/b0d4609bc46c2d88a8318706bb5321f7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d9593871ef400d3407c709c2ac852c50d2a3e4da --- /dev/null +++ b/marked/Rel-18/32_series/32156/b0d4609bc46c2d88a8318706bb5321f7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41ac18c27835c4071ca3cb29451820e1d5403eb2fff1a2466ba2c9b0671bcb90 +size 10162 diff --git a/marked/Rel-18/32_series/32156/b2ddf2a678bd20b1b491023eb1db6458_img.jpg b/marked/Rel-18/32_series/32156/b2ddf2a678bd20b1b491023eb1db6458_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2990b01b71ad16a01957361955b25a1cbfd4581b --- /dev/null +++ b/marked/Rel-18/32_series/32156/b2ddf2a678bd20b1b491023eb1db6458_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6a7dec1810110fcb3b9091b390a542a1407aa61686c5dfd2b892f3d28b3d3916 +size 75779 diff --git a/marked/Rel-18/32_series/32156/b904ac2472cab80892d1e783e6230d6e_img.jpg b/marked/Rel-18/32_series/32156/b904ac2472cab80892d1e783e6230d6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7c53f9ffd7e4fb338796289476f8833afd3a1205 --- /dev/null +++ b/marked/Rel-18/32_series/32156/b904ac2472cab80892d1e783e6230d6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c505f0e38e39ccc0967a0e0038d7287398fa157f413af6c627550570792691fb +size 47274 diff --git a/marked/Rel-18/32_series/32156/c42e926097d01653b793c04b49e764b2_img.jpg b/marked/Rel-18/32_series/32156/c42e926097d01653b793c04b49e764b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7b0badc5c8983b26d0e7480abe36c05504a0f37 --- /dev/null +++ b/marked/Rel-18/32_series/32156/c42e926097d01653b793c04b49e764b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae3d89db7929673f4b845fb9ac8907313983e19e97697bd3d4406829286b72e0 +size 12157 diff --git a/marked/Rel-18/32_series/32156/c6005b2627c6ca10f6b0e94cdb34858d_img.jpg b/marked/Rel-18/32_series/32156/c6005b2627c6ca10f6b0e94cdb34858d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..47f4a7e3d5a9a1aa71fa5f461187c6a80f7490df --- /dev/null +++ b/marked/Rel-18/32_series/32156/c6005b2627c6ca10f6b0e94cdb34858d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:851e278d10a5b8c62ffd952d053b49cf0beb20f9ffe8e6dd74c7167659a62a49 +size 6820 diff --git a/marked/Rel-18/32_series/32156/cd48273072c5c3a23e11fde892d1b6b6_img.jpg b/marked/Rel-18/32_series/32156/cd48273072c5c3a23e11fde892d1b6b6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b5df0cb90b20f90e222296497ce738f111a53f25 --- /dev/null +++ b/marked/Rel-18/32_series/32156/cd48273072c5c3a23e11fde892d1b6b6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f752144002b213b6ba87f85583a211eb72bb80ef1151ce4bece1da6e9740e954 +size 4032 diff --git a/marked/Rel-18/32_series/32156/dd380ccd5aca1151074fede04826f1a4_img.jpg b/marked/Rel-18/32_series/32156/dd380ccd5aca1151074fede04826f1a4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b97cad59c0bb8a6082c832eb5975070f8cdfe46 --- /dev/null +++ b/marked/Rel-18/32_series/32156/dd380ccd5aca1151074fede04826f1a4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06581b4ecfbfdecc1d4d38b800089ddd940b8fe0194fbf392a4afaeeae23f1f4 +size 12487 diff --git a/marked/Rel-18/32_series/32156/ddf10bebbd3dec2d885f0f7bbe953492_img.jpg b/marked/Rel-18/32_series/32156/ddf10bebbd3dec2d885f0f7bbe953492_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1150546e582ebc31b409f09f808c05cf1589aa1c --- /dev/null +++ b/marked/Rel-18/32_series/32156/ddf10bebbd3dec2d885f0f7bbe953492_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf46a047d68f97247de963df7202d2b474d3c60fee1f48b0d27158e3cb6c58af +size 16645 diff --git a/marked/Rel-18/32_series/32156/e190b6ddb7c2e64b940749a1c5612256_img.jpg b/marked/Rel-18/32_series/32156/e190b6ddb7c2e64b940749a1c5612256_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cdd37c7ae72551f9311e03a11d179d4ef900d178 --- /dev/null +++ b/marked/Rel-18/32_series/32156/e190b6ddb7c2e64b940749a1c5612256_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef59b82b4b90ea201fd651b1a9f6cdb9c8bafdb9396e4a7dac6fc0fcde9e3b6a +size 14049 diff --git a/marked/Rel-18/32_series/32156/eb1a67ebd688e354edaacb7ec2abf5ad_img.jpg b/marked/Rel-18/32_series/32156/eb1a67ebd688e354edaacb7ec2abf5ad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a2e2c923dbda6a08011a981b5248cacd9bbbf63f --- /dev/null +++ b/marked/Rel-18/32_series/32156/eb1a67ebd688e354edaacb7ec2abf5ad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:def5e9608433974d1e6cab0252490c2f332cdc25cc870332c44b72681596627c +size 4659 diff --git a/marked/Rel-18/32_series/32156/eb5677b570ab2a3e9d8f5d35ca5b8a4d_img.jpg b/marked/Rel-18/32_series/32156/eb5677b570ab2a3e9d8f5d35ca5b8a4d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..80ab7882f5d99f31a248734c77f42d46af413172 --- /dev/null +++ b/marked/Rel-18/32_series/32156/eb5677b570ab2a3e9d8f5d35ca5b8a4d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ed9036b891104d0bd636b0ac92a2a9301e6bc792eb79785ce961b66b3c09fdea +size 29946 diff --git a/marked/Rel-18/32_series/32156/f1fbb1287d999c7034742de35bdab836_img.jpg b/marked/Rel-18/32_series/32156/f1fbb1287d999c7034742de35bdab836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a71bfdd0ddc67e40f9a5af0c9fb64dd8fc915223 --- /dev/null +++ b/marked/Rel-18/32_series/32156/f1fbb1287d999c7034742de35bdab836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d61eef0da6ae145cd855460350d3aa63db76141d2730c512ccb86c1b526b364d +size 12036 diff --git a/marked/Rel-18/32_series/32156/raw.md b/marked/Rel-18/32_series/32156/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bdaeeba7e95d6daac3423d4874419b699bff55ae --- /dev/null +++ b/marked/Rel-18/32_series/32156/raw.md @@ -0,0 +1,1637 @@ + + +# 3GPP TS 32.156 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Fixed Mobile Convergence (FMC) Model repertoire (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +Fixed Mobile Convergence, FMC, Model +Repertoire, 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** + + + +## --- **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. + +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 ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 4 Requirements ..... | 10 | +| 5 Model elements and notations..... | 10 | +| 5.1 General ..... | 10 | +| 5.2 Basic model elements..... | 10 | +| 5.2.1 Attribute..... | 11 | +| 5.2.1.1 Description..... | 11 | +| 5.2.1.2 Example ..... | 13 | +| 5.2.1.3 Name style ..... | 13 | +| 5.2.2 Association relationship ..... | 14 | +| 5.2.2.1 Description..... | 14 | +| 5.2.2.2 Example ..... | 14 | +| 5.2.2.3 Name style ..... | 14 | +| 5.2.3 Aggregation association relationship ..... | 15 | +| 5.2.3.1 Description..... | 15 | +| 5.2.3.2 Example ..... | 15 | +| 5.2.3.3 Name style ..... | 15 | +| 5.2.4 Composite aggregation association relationship ..... | 15 | +| 5.2.4.1 Description..... | 15 | +| 5.2.4.2 Example ..... | 15 | +| 5.2.4.3 Name style ..... | 16 | +| 5.2.5 Generalization relationship..... | 16 | +| 5.2.5.1 Description..... | 16 | +| 5.2.5.2 Example ..... | 16 | +| 5.2.5.3 Name style ..... | 16 | +| 5.2.6 Dependency relationship ..... | 16 | +| 5.2.6.1 Description..... | 16 | +| 5.2.6.2 Example ..... | 16 | +| 5.2.6.3 Name style ..... | 17 | +| 5.2.7 Comment ..... | 17 | +| 5.2.7.1 Description..... | 17 | +| 5.2.7.2 Example ..... | 17 | +| 5.2.7.3 Name style ..... | 17 | +| 5.2.8 Multiplicity, a.k.a. cardinality in relationships ..... | 17 | +| 5.2.8.1 Description..... | 17 | +| 5.2.8.2 Example ..... | 17 | +| 5.2.8.3 Name style ..... | 18 | +| 5.2.9 Role..... | 18 | +| 5.2.9.1 Description..... | 18 | +| 5.2.9.2 Example ..... | 19 | +| 5.2.9.3 Name style ..... | 19 | +| 5.2.10 Xor constraint ..... | 19 | +| 5.2.10.1 Description..... | 19 | +| 5.2.10.2 Example ..... | 19 | +| 5.2.10.3 Name style ..... | 20 | +| 5.2.11 LifecycleStatus ..... | 20 | +| 5.2.11.1 Description..... | 20 | +| 5.2.11.2 Removing/Deprecating model elements ..... | 20 | +| 5.3 Stereotype..... | 21 | + +| | | | +|-------------------------------|--------------------------------------------------------------|-----------| +| 5.3.0 | Description ..... | 21 | +| 5.3.1 | <> ..... | 21 | +| 5.3.1.1 | Description..... | 21 | +| 5.3.1.2 | Example ..... | 21 | +| 5.3.1.3 | Name style ..... | 21 | +| 5.3.2 | <> ..... | 22 | +| 5.3.2.1 | Description..... | 22 | +| 5.3.2.2 | Example ..... | 22 | +| 5.3.2.3 | Name style ..... | 22 | +| 5.3.3 | <> ..... | 22 | +| 5.3.3.1 | Description..... | 22 | +| 5.3.3.2 | Example ..... | 23 | +| 5.3.3.3 | Name style ..... | 23 | +| 5.3.4 | <> ..... | 23 | +| 5.3.4.1 | Description..... | 23 | +| 5.3.4.2 | Example ..... | 25 | +| 5.3.4.3 | Name style ..... | 25 | +| 5.3.5 | <> ..... | 26 | +| 5.3.5.1 | Description..... | 26 | +| 5.3.5.2 | Example ..... | 26 | +| 5.3.5.3 | Name style ..... | 26 | +| 5.3.6 | <> ..... | 26 | +| 5.3.6.1 | Description..... | 26 | +| 5.3.6.2 | Example ..... | 26 | +| 5.3.6.3 | Name style ..... | 27 | +| 5.4 | Others ..... | 27 | +| 5.4.1 | Association class ..... | 27 | +| 5.4.1.1 | Description..... | 27 | +| 5.4.1.2 | Example ..... | 28 | +| 5.4.1.3 | Name style ..... | 28 | +| 5.4.2 | Abstract class..... | 28 | +| 5.4.2.1 | Description..... | 28 | +| 5.4.2.2 | Example ..... | 28 | +| 5.4.2.3 | Name style ..... | 28 | +| 5.4.3 | Predefined data types..... | 29 | +| 5.4.3.1 | Description..... | 29 | +| 5.4.3.2 | Example ..... | 29 | +| 5.4.3.3 | Name style ..... | 29 | +| 6 | Qualifiers..... | 30 | +| 7 | UML Diagram Requirements..... | 31 | +| Annex A (informative): | Examples of using <<ProxyClass>> ..... | 32 | +| A.1 | First Example ..... | 32 | +| A.2 | Second Example..... | 33 | +| Annex B (normative): | Attribute properties ..... | 34 | +| Annex C (normative): | Design patterns ..... | 35 | +| C.1 | Intervening class and Association class ..... | 35 | +| C.1.1 | Concept and definition ..... | 35 | +| C.1.2 | Usage in the non-transport domain ..... | 37 | +| C.1.3 | Usage in the transport domain..... | 37 | +| C.2 | Use of “ExternalXyz” class..... | 38 | +| Annex D (informative): | Void..... | 39 | +| Annex E (normative): | <<SupportIOC>> stereotype definition..... | 40 | +| E.1 | Description..... | 40 | + +| | | | +|------------------------------|---------------------------------------------------------------------------------------------------|-----------| +| E.2 | Example ..... | 40 | +| E.3 | Name style ..... | 40 | +| Annex F (normative): | Application of <<InformationObjectClass>> and
<SupportIOC>> ..... | 41 | +| Annex G(informative): | Change history..... | 43 | + +# --- 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 + +UML provides a rich set of concepts, notations and model elements to model distributive systems. This paper documents the necessary and sufficient set of UML notations and model elements, including the ones built by the UML extension mechanism <> to model network management systems and their managed nodes. This set of notations and model elements is called the FMC (developed by the Converged Management of Fixed/Mobile Networks project) Model Repertoire; see also 3GPP TS 32.107 [5] and 3GPP TS 28.620 [6]. + +# --- 2 References + +- [1] OMG "Unified Modelling Language (OMG UML), Infrastructure", Version 2. 4. +- [2] OMG "Unified Modelling Language (OMG UML), Superstructure", Version 2. 4. +- [3] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [4] Void +- [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] ITU-T X.680,"OSI networking and system aspects – Abstract Syntax Notation One (ASN.1)". +- [8] Void +- [9] 3GPP TS 32.602 "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (IS)". +- [10] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM 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 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [13] 3GPP TS 32.404: "Telecommunication management; Performance Management (PM); Performance measurements - Definitions and template". +- [14] 3GPP TS 28.545 "Management and orchestration; Fault Supervision (FS)". +- [15] 3GPP TS 28.541 "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [16] 3GPP TS 28.532 "Management and orchestration; Generic management services". +- [17] 3GPP TS 28.531 "Management and orchestration; Provisioning". +- [18] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [19] 3GPP TS 32.102: “Telecommunication management; Architecture”. +- [20] 3GPP TS 28.533: “Management and orchestration; Architecture framework”. + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [18] 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 [18]. + +**Naming attribute:** It is a class attribute that holds the class instance identifier. See attribute *id* of *Top\_* in TS 28.620 [6]. See examples of naming attribute in 3GPP TS 32.300 [3]. + +**Lower Camel Case:** The practice of writing compound words in which the words are joined without spaces and that the initial letter of all except the first word is capitalized. + +EXAMPLES: 'managedNodeIdentity' and 'minorDetails' are the LCC for "managed node identity" and "minor details" respectively. + +**Upper Camel Case:** The practice of writing compound words in which the words are joined without spaces and that the initial letters of all words are capitalised. + +EXAMPLES: 'ManagedNodeIdentity' and 'MinorDetails' are the UCC for "managed node identity" and "minor details" respectively. + +**Well Known Abbreviation:** An abbreviation that can be used as the modelled element name or as a component of a modelled element name. + +NOTE 1: The abbreviation, when used in such manner, is in the same document where the modelled element is defined. + +**Manager:** IRP Manager or MnS consumer + +NOTE 2: In the context of the IRP framework as defined in TS 32.102 [x], the term manager designates the IRP Manager. In the context of the SBMA framework as defined in TS 28.533 [y], the term manager designates the MnS consumer. + +**Agent:** IRP Agent or MnS producer + +NOTE 3: In the context of the IRP framework as defined in TS 32.102 [x], the term agent designates the IRP Agent. In the context of the SBMA framework as defined in TS 28.533 [y], the term agent designates the MnS producer. + +**Data type:** Constraint on an attribute value. + +**Simple type:** Data type constraining an attribute value to a scalar. + +**Complex type:** Data type of a structured and/or multi-valued attribute. + +**Attribute:** Information element of an object composed of an attribute name and an attribute value. + +**Attribute name:** Name of an attribute. + +**Attribute value:** Value of an attribute that is defined by a simple type or a complex type. + +**Attribute field:** Attribute contained in an attribute that can contain attribute fields. + +**Attribute field name:** Name of an attribute field. + +**Attribute field value:** Value of an attribute field defined by a simple type or a complex type. + +**Simple attribute:** Attribute whose value is a simple type. + +**Complex attribute:** Attribute whose value is a complex type. + +**Structured attribute:** A kind of a complex attribute whose value contains one or more attribute fields + +**Multi-valued attribute:** A kind of a complex attribute with multiplicity > 1. + +**Attribute element:** A single value of a multi-valued attribute. + +**Attribute field element:** A single value of a multi-valued attribute field. + +**Data node:** An object, an attribute, an attribute field, an attribute element, or an attribute field element. + +**Attribute data node:** An attribute, an attribute field, an attribute element, or an attribute field element. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [18], 3GPP TS 28.620 [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 [18], and 3GPP TS 28.620 [6]. + +| | | +|-----|-----------------------------| +| CM | Conditional Mandatory | +| CO | Conditional Optional | +| IRP | Integration Reference Point | +| LCC | Lower Camel Case | +| M | Mandatory | +| MnS | Management Service | +| NA | Not Applicable | +| O | Optional | +| OMG | Object Management Group | +| UCC | Upper Camel Case | +| WKA | Well Known Abbreviation | + +# 4 Requirements + +The UML notations and model elements captured in this repertoire shall be used to model behaviours of the systems/entities such as the Umbrella Information Model (UIM) of the FNIM in 3GPP TS 28.620 [6]. + +# 5 Model elements and notations + +## 5.1 General + +Note that the graphical notation in this document is only used to represent particular model elements. Although the graphical notation is a correct representation of the model element, it may not be a valid representation of a UML class diagram. + +The examples used in this document are for illustration purposes only and may or may not exist in specifications. + +UML properties not described in this document shall not be used in specifications based on this repertoire. + +## 5.2 Basic model elements + +UML has defined a number of basic model elements. This subclause lists the subset selected for use in specifications based on this repertoire. The semantics of these selected basic model elements are defined in [1]. + +For each basic model element listed, there are three parts. The first part contains its description. The second part contains its graphical notation examples and the third part contains the rule, if any, recommended for labelling or naming it. + +The graphical notation has the following characteristics: + +- Subclause 7.2.7 of [2] specifies "A class is often shown with three compartments. The middle compartment holds a list of attributes while the bottom compartment holds a list of operations" and "Additional compartments may be supplied to show other details". This repertoire only allows the use of the name (top) compartment and attribute (middle) compartment. The operation (bottom) compartment may be present but is always empty. + +![UML class diagram showing a class with two compartments: the top compartment contains '' and the middle compartment contains 'attribute'.](cd48273072c5c3a23e11fde892d1b6b6_img.jpg) + +| | +|--------------| +| | +| attribute | + +UML class diagram showing a class with two compartments: the top compartment contains '' and the middle compartment contains 'attribute'. + +- Classes may or may not have attributes. The graphical notation of a class may show an empty attribute (middle) compartment even if the class has attributes, as shown in figure below. + +![UML class diagram showing a class with three compartments: the top compartment contains '«InformationObjectClass»', the middle compartment contains 'Xyz', and the bottom compartment is empty.](c6005b2627c6ca10f6b0e94cdb34858d_img.jpg) + +| | +|--------------------------| +| «InformationObjectClass» | +| Xyz | +| | + +UML class diagram showing a class with three compartments: the top compartment contains '«InformationObjectClass»', the middle compartment contains 'Xyz', and the bottom compartment is empty. + +- The visibility symbol shall not appear along with the class attribute, as shown below. + +![UML class diagram showing a class named 'Xyz' with the stereotype '«InformationObjectClass»'. The class has three attributes: 'a', 'b', and 'c'.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` +classDiagram + class Xyz { + <> + a + b + c + } +``` + +UML class diagram showing a class named 'Xyz' with the stereotype '«InformationObjectClass»'. The class has three attributes: 'a', 'b', and 'c'. + +→ The use of the decoration, i.e. the symbol in the name (top) compartment, is optional. + +### 5.2.1 Attribute + +#### 5.2.1.1 Description + +An attribute is a typed element representing a property of a class (Unified Modelling Language (OMG UML), Infrastructure [1], clause 10.2.5.). An element that is typed implies that the element can only refer to a constrained set of values. See clause 10.1.4 of [1] for more information on type. + +See clauses 5.3.4 and 5.4.3 for predefined data types and user-defined data types that can apply type information to an attribute. + +The properties of an attribute are described by a set of attribute properties categorized as follows: + +- Attribute properties defining valid attribute values: type, allowedValues, multiplicity, isOrdered, isUnique, isNullable, passedById. +- Attribute properties defining valid interactions of managers and agents with attributes values: isInvariant, isWritable, isReadable, isNotifyable, defaultValue. +- Other attribute properties: documentation, supportQualifier. + +The following tables provide definitions for the attributes of the three categories. + +**Table 5.2.1.1-1: Attribute properties defining valid attribute values** + +| Property name | Description | Legal values | +|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| +| type | Refers to a predefined (subclause 5.4.3) or user defined data type (section 5.3.4). See also subclause 7.3.44 of [2], inherited from StructuralFeature. | NA | +| allowedValues | Specifies restrictions to the data type defined by type. This property is useful when no dedicated data type, that includes the restriction, shall be defined. The property may be absent when no restrictions are defined. | Dependent on type | +| defaultValue | Identifies a value at specification time that is used at object creation time under conditions defined in Annex B.
If there is no defined default value, the property shall be omitted from the attribute description or specified as 'defaultValue: None.'. | None (default) or a value that is dependent on allowedValues | +| multiplicity | Defines the number of values the attribute can simultaneously have. See subclause 7.3.44 of [2]; inherited from StructuralFeature. | See 5.2.8 Default is 1 | +| isOrdered | For a multi-valued multiplicity, this specifies if the values of this attribute instance are sequentially ordered. See subclause 7.3.44 and its Table 7.1 of [2].
If the property is present for attributes with a multiplicity of greater than "1", it shall be set to either "True" or "False". It shall not be set to "N/A". | True, False (default) | +| isUnique | For a multi-valued multiplicity, this specifies if the values of this attribute instance are unique (i.e., no duplicate attribute values). See subclause 7.3.44 and its Table 7.1 of [2].
If the property is present for attributes with a multiplicity of greater than "1", it shall be set to either "True" or "False". It shall not be set to "N/A". | True (default), False | +| isNullable | Identifies if an attribute can carry no information. The implied meaning of carrying "no information" is context sensitive and is not defined in this Model Repertoire.
Note, the property "isNullable: True" is semantically identical to adding the value "0" to the "multiplicity" specified. Usage of the "multiplicity" property is preferred to express an attribute can have no value or carry no information. | True, False (default) | +| passedById | Usage of the value False is deprecated.
The property is only applicable to attributes related to roles, for other attributes it has no significance,
See Table 5.2.9.1-1: passedById property | True(default), False | +| lifecycleStatus | See Table 5.2.A.1-1 | Current (default), Deprecated | + +**Table 5.2.1.1-2: Attribute properties defining valid interactions with attributes** + +| Property name | Description | Legal values | +|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| isInvariant |

If an attribute has an "isInvariant: True" property, its value can be set only upon object creation. After object creation, the initial value cannot be modified by any entity.

If an attribute has an "isInvariant: False" property, its value can be set at object creation time. After object creation, the initial value can be modified.

Details on how initial values are provided upon object creation are specified in Annex B.

| True, False (default) | +| isWritable |

If an attribute has an "isWritable: True" property, a manager can set its value upon object creation. After object creation, a manager can modify the initial value if "isInvariant: False". If "isInvariant: True", a manager cannot modify the initial value. The "isInvariant" property supersedes hence the "isWritable" property.

If an attribute has an "isWritable: False" property, a manager cannot set the value upon object creation nor modify it later.

A "isWritable: True" property might be restricted by access control.

| True, False (default) | +| isReadable |

Specifies if the attribute can be read by a manager.

A "isReadable: True" property might be restricted by access control.

| True , False (default) | +| isNotifyable | Identifies if a notification shall be sent in case of an attribute value change. | True (default), False | + +**Table 5.2.1.1-3: Attribute properties related to the specification of attributes** + +| Property name | Description | Legal values | +|------------------|------------------------------------------------------------------------------------------------------------------------|---------------------------| +| documentation | Contains a textual description of the attribute.
Should refer (to enable traceability) to the specific requirement. | Any | +| supportQualifier | Identifies the required support of the attribute. See also subclause 6. | M, O (default), CM, CO, C | + +Upon completion of any manipulation of an attribute the attribute properties related to valid attribute values shall be respected. If an interaction results in violating at least one of these properties, the manipulation request shall be rejected. + +The value N/A (Not applicable) shall not be used for attribute properties except for properties "isOrdered", "isUnique" and "allowedValues". + +#### 5.2.1.2 Example + +This example shows three attributes, i.e., a, b and c, listed in the attribute (the second) compartment of the class Xyz. + +![UML class diagram showing a class named Xyz with three attributes: a, b, and c.](5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg) + +``` + +classDiagram + class Xyz { + a + b + c + } + +``` + +UML class diagram showing a class named Xyz with three attributes: a, b, and c. + +**Figure 5.2.1.2-1: Attribute notation** + +#### 5.2.1.3 Name style + +An attribute name shall use the LCC style. + +Well Known Abbreviation (WKA) is treated as a word if used in a name. However, WKA shall be used as is (its letter case cannot be changed) except when it is the first word of a name; and if so, its first letter must be in lower case. + +### 5.2.2 Association relationship + +#### 5.2.2.1 Description + +It shows a relationship between two classes and describes the reasons for the relationship and the rules that might govern that relationship. + +It has ends. Its end, the association end(s), specifies the role that the object at one end of a relationship performs. Each end of a relationship has properties that specify the role (see 5.2.9), multiplicity (see 5.2.8), visibility and navigability (see the arrow symbol used in Figure 5.2.2.2-2: Unidirectional association relationship notation) and may have constraints. Note that visibility shall not be used in models based on this Repertoire (see bullet 3 of 5.2). + +See 7.3.3 Association of [2]. + +Three examples below show a binary association between two model elements. The association can include the possibility of relating a model element to itself. + +The first example (Figure 5.2.2.2-1) shows a bi-directional navigable association in that each model element has a pointer to the other. The second example (Figure 5.2.2.2-2) shows a unidirectional association (shown with an open arrow at the target model element end) in that only the source model element has a pointer to the target model element and not vice-versa. The third example (Figure 5.2.2.2-3) shows a bi-directional non-navigable association in that each model element does not have a pointer to the other; i.e., such associations are just for illustration purposes. + +#### 5.2.2.2 Example + +An association shall have an indication of cardinality (see 5.2.8). + +It shall, except the case of non-navigable association, have an indication of the role name (see 5.2.9). The model element involved in an association is said to be "playing a role" in that association. The role has a name such as aClass in the first example below. Note that the use of "+" character in front of the role name, indicating visibility, is optional. + +![Figure 5.2.2.2-1: Bidirectional association relationship notation. A diagram showing two classes, AClass and BClass, connected by a bidirectional association. AClass has a multiplicity of 0..1 and role name +aClass. BClass has a multiplicity of * and role name +bClass.](e190b6ddb7c2e64b940749a1c5612256_img.jpg) + +``` + +classDiagram + class AClass["0..1"] { + +aClass + } + class BClass["*"] { + +bClass + } + AClass <--> BClass + +``` + +Figure 5.2.2.2-1: Bidirectional association relationship notation. A diagram showing two classes, AClass and BClass, connected by a bidirectional association. AClass has a multiplicity of 0..1 and role name +aClass. BClass has a multiplicity of \* and role name +bClass. + +Figure 5.2.2.2-1: Bidirectional association relationship notation + +![Figure 5.2.2.2-2: Unidirectional association relationship notation. A diagram showing two classes, Class8 and Class9, connected by a unidirectional association. Class8 has a multiplicity of * and role name +class9. Class9 has a multiplicity of 0..1 and role name +class9.](a6cf7c02a60c336e0934b5ea40e35b49_img.jpg) + +``` + +classDiagram + class Class8["*"] { + +class9 + } + class Class9["0..1"] { + +class9 + } + Class8 --> Class9 + +``` + +Figure 5.2.2.2-2: Unidirectional association relationship notation. A diagram showing two classes, Class8 and Class9, connected by a unidirectional association. Class8 has a multiplicity of \* and role name +class9. Class9 has a multiplicity of 0..1 and role name +class9. + +Figure 5.2.2.2-2: Unidirectional association relationship notation + +![Figure 5.2.2.2-3: Non-navigable association relationship notation. A diagram showing two classes, Class10 and Class11, connected by a non-navigable association. Class10 has a multiplicity of 1 and role name +class11. Class11 has a multiplicity of * and role name +class11.](9db324c513563a95ae55c77f4462a969_img.jpg) + +``` + +classDiagram + class Class10["1"] { + +class11 + } + class Class11["*"] { + +class11 + } + Class10 -- Class11 + +``` + +Figure 5.2.2.2-3: Non-navigable association relationship notation. A diagram showing two classes, Class10 and Class11, connected by a non-navigable association. Class10 has a multiplicity of 1 and role name +class11. Class11 has a multiplicity of \* and role name +class11. + +Figure 5.2.2.2-3: Non-navigable association relationship notation + +Note that some tools do not use arrows in the UML graphical representation for bidirectional associations. Therefore, absence of the two arrows is not an indication of a non-navigable association between the two Information Object Class involved; but the absence of the attributes related to role in the two Information Object Class involved is an indication. + +#### 5.2.2.3 Name style + +An Association can have a name. Use of Association name is optional. Its name style is LCC style. + +A role name shall use the LCC style. + +NOTE: The role name needs not resemble the class name. + +### 5.2.3 Aggregation association relationship + +#### 5.2.3.1 Description + +It shows a class as a part of or subordinate to another class. + +An aggregation is a special type of association in which objects are assembled or configured together to create a more complex object. Aggregation protects the integrity of an assembly of objects by defining a single point of control called aggregate, in the object that represents the assembly. + +See 7.3.2 AggregationKind (from Kernel) of [2]. + +#### 5.2.3.2 Example + +A hollow diamond attached to the end of a relationship is used to indicate an aggregation. The diamond is attached to the class that is the aggregate. The aggregation association shall have an indication of cardinality at each end of the relationship (see 5.2.8). + +![UML Class Diagram showing an aggregation association between Class12 and Class13. Class12 is on the left with a hollow diamond and a '1' cardinality. Class13 is on the right with a '*' cardinality. The association is labeled '+class13'.](70de8885bd7de15723aaad5eb5c5febf_img.jpg) + +``` + +classDiagram + Class12 "1" o-- "*" Class13 : +class13 + class "«InformationObjectClass»" Class12 + class "«InformationObjectClass»" Class13 + +``` + +UML Class Diagram showing an aggregation association between Class12 and Class13. Class12 is on the left with a hollow diamond and a '1' cardinality. Class13 is on the right with a '\*' cardinality. The association is labeled '+class13'. + +**Figure 5.2.3.2-1: Aggregation association relationship notation** + +#### 5.2.3.3 Name style + +An Association can have a name. Use of Association name is optional. Its name style is LCC. + +### 5.2.4 Composite aggregation association relationship + +#### 5.2.4.1 Description + +A composite aggregation association is a strong form of aggregation that requires a part instance be included in at most one composite at a time. If a composite is deleted, all of its parts are deleted as well. + +A composite aggregation shall contain a description of its use. + +See 7.3.3 Association (from Kernel) of [2]. + +#### 5.2.4.2 Example + +A filled diamond attached to the end of a relationship is used to indicate a composite aggregation. The diamond is attached to the class that is the composite. The composite association shall have an indication of cardinality at each end of the relationship (see 5.2.8). + +![UML Class Diagram showing a composite aggregation association between ManagedElement and ManagedElementPropertySet. ManagedElement is on the left with a filled diamond and a '1' cardinality. ManagedElementPropertySet is on the right with a '0..1' cardinality. The association is labeled '+managedElementPropertySet'.](ddf10bebbd3dec2d885f0f7bbe953492_img.jpg) + +``` + +classDiagram + ManagedElement "1" *-- "0..1" ManagedElementPropertySet : +managedElementPropertySet + class "«InformationObjectClass»" ManagedElement + class "«InformationObjectClass»" ManagedElementPropertySet + +``` + +UML Class Diagram showing a composite aggregation association between ManagedElement and ManagedElementPropertySet. ManagedElement is on the left with a filled diamond and a '1' cardinality. ManagedElementPropertySet is on the right with a '0..1' cardinality. The association is labeled '+managedElementPropertySet'. + +**Figure 5.2.4.2-1: Composite aggregation association relationship notation** + +#### 5.2.4.3 Name style + +An Association can have a name. Use of Association name is optional. Its name style is LCC. + +### 5.2.5 Generalization relationship + +#### 5.2.5.1 Description + +It indicates a relationship in which one class (the child) inherits from another class (the parent). + +See 7.3.20 Generalization of [2]. + +#### 5.2.5.2 Example + +This example shows a generalization relationship between a more general model element (the Top) and a more specific model element (the NetworkSliceSubnet) that is fully consistent with the first element and that adds additional information. + +![UML diagram showing a generalization relationship between Top and NetworkSliceSubnet classes.](96b0240f56d14453b5da05ec30fd5c6e_img.jpg) + +``` +classDiagram + class Top { + <> + } + class NetworkSliceSubnet { + <> + } + Top <|-- NetworkSliceSubnet +``` + +The diagram shows two rectangular boxes representing classes. The box on the left is labeled '<> Top'. The box on the right is labeled '<> NetworkSliceSubnet'. A solid line with an open triangle arrowhead points from the NetworkSliceSubnet box to the Top box, indicating that NetworkSliceSubnet inherits from Top. + +UML diagram showing a generalization relationship between Top and NetworkSliceSubnet classes. + +Figure 5.2.5.2-1: Generalization relationship notation + +#### 5.2.5.3 Name style + +It has no name so there is no name style. + +### 5.2.6 Dependency relationship + +#### 5.2.6.1 Description + +"A dependency is a relationship that signifies that a single or a set of model elements requires other model elements for their specification or implementation. This means that the complete semantics of the depending elements is either semantically or structurally dependent on the definition of the supplier element(s)...", an extract from 7.3.12 Dependency of [2]. + +#### 5.2.6.2 Example + +This example shows that the BClass instances have a semantic relationship with the AClass instances. It indicates a situation in which a change to the target element (the AClass in the example) will require a change to the source element (the BClass in the example) in the dependency. + +![UML diagram showing a dependency relationship between AClass and BClass classes.](73b706c7393e92b17699c773f18918ff_img.jpg) + +``` +classDiagram + class AClass { + <> + } + class BClass { + <> + } + BClass ..> AClass +``` + +The diagram shows two rectangular boxes representing classes. The box on the left is labeled '<> AClass'. The box on the right is labeled '<> BClass'. A dashed line with an open arrowhead points from the BClass box to the AClass box, indicating that BClass depends on AClass. + +UML diagram showing a dependency relationship between AClass and BClass classes. + +Figure 5.2.6.2-1: Dependency relationship notation + +#### 5.2.6.3 Name style + +A Dependency can have a name. Use of Dependency name is optional. Its name style is LCC. + +### 5.2.7 Comment + +#### 5.2.7.1 Description + +A comment is a textual annotation that can be attached to a set of elements. + +See 7.3.9 Comment (from Kernel) from [2]. + +#### 5.2.7.2 Example + +This example shows a comment, as a rectangle with a "bent corner" in the upper right corner. It contains text. It appears on a particular diagram and may be attached to zero or more modelling elements by dashed lines. + +![UML diagram showing a class box labeled '«InformationObjectClass» NRCellDU' connected by a dashed line to a comment box labeled 'This is a comment'.](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +A UML diagram showing a class box on the left labeled with the stereotype «InformationObjectClass» and the name NRCellDU. A dashed line extends from the right side of the class box to a comment box on the right. The comment box is a rectangle with a small triangular 'bent corner' at its top-right edge and contains the text 'This is a comment'. + +UML diagram showing a class box labeled '«InformationObjectClass» NRCellDU' connected by a dashed line to a comment box labeled 'This is a comment'. + +Figure 5.2.7.2-1: Comment notation + +#### 5.2.7.3 Name style + +It has no name so there is no name style. + +### 5.2.8 Multiplicity, a.k.a. cardinality in relationships + +#### 5.2.8.1 Description + +"A multiplicity is a definition of an inclusive interval of non-negative integers beginning with a lower bound and ending with a (possibly infinite) upper bound. A multiplicity element embeds this information to specify the allowable cardinalities for an instantiation of this element...", an extract from 7.3.32 MultiplicityElement of [2]. + +Table 5.2.8.1-1: Multiplicity-string definitions + +| Multiplicity | Explanation | +|--------------|-----------------------------------------------------------------------------| +| 1 | Attribute has one attribute value. | +| m | Attribute has m attribute values. | +| 0..1 | Attribute has zero or one attribute value. | +| 0..* | Attribute has zero or more attribute values. | +| * | Attribute has zero or more attribute values. | +| 1..* | Attribute has at least one attribute value. | +| m..n | Attribute has at least m but no more than n attribute values. | + +The use of "0..n" is not recommended although it has the same meaning as "0..\*" and "\*". + +The use of a standalone symbol zero (0) is not allowed. + +#### 5.2.8.2 Example + +This example shows a multiplicity attached to the end of an association path. The meaning of this multiplicity is one to many. One Class1 instance is associated with zero or more Class2 instances. Other valid examples can show the "many to many" relationship. + +![UML diagram showing cardinality notation. A class box labeled '«InformationObjectClass» Class1' is connected by a directed association to another class box labeled '«InformationObjectClass» Class2'. The association has a multiplicity of '1' at the Class1 end and a multiplicity of '*' at the Class2 end. The role name '+class2' is placed near the Class2 end of the association line.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +UML diagram showing cardinality notation. A class box labeled '«InformationObjectClass» Class1' is connected by a directed association to another class box labeled '«InformationObjectClass» Class2'. The association has a multiplicity of '1' at the Class1 end and a multiplicity of '\*' at the Class2 end. The role name '+class2' is placed near the Class2 end of the association line. + +**Figure 5.2.8.2-1: Cardinality notation** + +The cardinality zero is not used to indicate the IOC's so-called "transient state" characteristic. For example, it is not used to indicate that the instance is not yet created but it is in the process of being created. The cardinality zero will not be used to indicate this characteristic since such characteristic is considered inherent in all IOCs. All IOCs defined are considered to have such inherent "transient state" characteristics. + +The following table shows some valid examples of multiplicity. + +**Table 5.2.8.2-1: Multiplicity-string examples** + +| Multiplicity | Explanation | +|--------------|----------------------------------------------------------------| +| 1 | Attribute has exactly one attribute value. | +| 5 | Attribute has exactly 5 attribute values. | +| 0..1 | Attribute has zero or one attribute value. | +| 0..* | Attribute has zero or more attribute values. | +| 1..* | Attribute has at least one attribute value. | +| 4..12 | Attribute has at least 4 but no more than 12 attribute values. | + +#### 5.2.8.3 Name style + +It has no name so there is no name style. + +### 5.2.9 Role + +#### 5.2.9.1 Description + +It indicates navigation, from one class to another class, involved in an association relationship. A role is named. The direction of navigation is to the class attached to the end of the association relationship with (or near) the role name. + +The use of role name in the graphical representation is optional for bidirectional and unidirectional association relationship notations (see Figure 5.2.2.2-1: Bidirectional association relationship notation and Figure 5.2.2.2-2: Unidirectional association relationship notation). Role name shall not be used in non-navigable association relationship notation (see Figure 5.2.2.2-3: Non-navigable association relationship notation). + +A role at the navigable end of a relationship becomes (or is mapped into) an attribute (called role-attribute) in the source class of the relationship. Therefore, roles have the same behaviour (or properties) as attributes. See Table 5.2.1.1-1: Attribute properties. + +To avoid clutter in UML diagram, the role names can be removed. + +The role-attribute shall have all properties defined for attributes in subclause 5.2.1 Attribute and in addition the following property + +**Table 5.2.9.1-1: passedByld property** + +| Property name | Description | Legal values | +|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| passedByld |

If True, the role-attribute (navigable association source end) contains a DN of the navigable association target end instance.

Usage of the value False is deprecated.

If False, the role-attribute contains (a copy of) the whole target end instance (e.g. X). If X has a role-attribute whose "passedByld==False", then the subject role-attribute contains (a copy of) X's target end instance as well.

The above rule is applied repeatedly for all occurrences of "passedByld==False". This application can result in a collection of instances where no ordering can be implied and no instances are duplicated.

Use of "passedByld==False" supports the efficient access of target end instances from a source end instance. The mechanism by which such access is achieved is operation model design specific (e.g. not related to resource model design).

| True (default),
False | + +: + +#### 5.2.9.2 Example + +This example shows that a Person (say instance John) is associated with a Company (say whose DN is "Company=XYZ"). We navigate the association by using the opposite association-end such that John's `Person.company` would hold the DN, i.e. "Company=XYZ". + +![UML Class Diagram showing a navigable association between Company and Person. The Company class (labeled <> Company) is on the left, and the Person class (labeled <> Person) is on the right. An association line connects them. At the Person end, there is a multiplicity of '1'. At the Company end, there is a multiplicity of '1' and a role name '+company'. An arrow points from the Person end to the Company end, indicating navigation from Person to Company via the 'company' role.](04f51626e2e10a16e3eb2c4b33cb2742_img.jpg) + +UML Class Diagram showing a navigable association between Company and Person. The Company class (labeled <> Company) is on the left, and the Person class (labeled <> Person) is on the right. An association line connects them. At the Person end, there is a multiplicity of '1'. At the Company end, there is a multiplicity of '1' and a role name '+company'. An arrow points from the Person end to the Company end, indicating navigation from Person to Company via the 'company' role. + +**Figure 5.2.9.2-1: Role notation** + +#### 5.2.9.3 Name style + +A role has a name. Use a noun for the name. The name style follows the attribute name style; see subclause 5.2.1.3. + +### 5.2.10 Xor constraint + +#### 5.2.10.1 Description + +“A Constraint represents additional semantic information attached to the constrained elements. A constraint is an assertion that indicates a restriction that must be satisfied by a correct design of the system. The constrained elements are those elements required to evaluate the constraint specification...“, an extract from 7.3.10 Constraint (from Kernel) of [2]. + +For a constraint that applies to two elements such as two associations, the constraint shall be shown as a dashed line between the elements labeled by the constraint string (in braces). The constraint string, in this case, is xor. + +#### 5.2.10.2 Example + +The figure below shows a `ServerObjectClass` instance that has relation(s) to multiple instances of a class from the choice of `ClientObjectClass_Alternative1`, `ClientObjectClass_Alternative2` or `ClientObjectClass_Alternative3`. + +![UML Class Diagram illustrating the {xor} notation for inheritance. A base class '«InformationObjectClass» ServerObjectClass' is at the top. Below it are three alternative classes: '«InformationObjectClass» ClientObjectClass_Alt1', '«InformationObjectClass» ClientObjectClass_Alt2', and '«InformationObjectClass» ClientObjectClass_Alt3'. Solid lines with open triangle arrows point from each alternative class to the base class. A dashed line with an open triangle arrow points from the base class to a box labeled '{xor}'. From this box, three dashed lines with open triangle arrows point to each of the three alternative classes. Each association line is labeled with '+clientObjectClass' and '*' multiplicity at the alternative class end. The base class has '1' multiplicity at its end of each association line.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +UML Class Diagram illustrating the {xor} notation for inheritance. A base class '«InformationObjectClass» ServerObjectClass' is at the top. Below it are three alternative classes: '«InformationObjectClass» ClientObjectClass\_Alt1', '«InformationObjectClass» ClientObjectClass\_Alt2', and '«InformationObjectClass» ClientObjectClass\_Alt3'. Solid lines with open triangle arrows point from each alternative class to the base class. A dashed line with an open triangle arrow points from the base class to a box labeled '{xor}'. From this box, three dashed lines with open triangle arrows point to each of the three alternative classes. Each association line is labeled with '+clientObjectClass' and '\*' multiplicity at the alternative class end. The base class has '1' multiplicity at its end of each association line. + +Figure 5.2.10.2-1: {xor} notation + +#### 5.2.10.3 Name style + +It has no name so there is no name style. + +### 5.2.11 LifecycleStatus + +#### 5.2.11.1 Description + +Model elements may have a life-cycle. They are created, updated, become obsolete and may be removed. The lifecycleStatus property indicates this. LifecycleStatus is applicable to attributes, data types, IOCs operations and notifications. + +Table 5.2.A.1-1: lifecycleStatus property + +| Property name | Description | Legal values | +|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| lifecycleStatus |

"Current" means that the definition of the element is current and valid, it is freely available for use.

"Deprecated" means the element has a valid definition, it is available for use, but its use is discouraged. Deprecated elements may already have a replacement element defined. Deprecated elements may be removed in the next release.

| Current(default),
Deprecated | + +#### 5.2.11.2 Removing/Deprecating model elements + +When removal or a non backwards compatible change is needed for a model element, it shall be kept in the specification as-is but be marked as deprecated for one release. The deprecated element may be removed in the next release. + +A new replacing model element may be defined beside the original. In this case the replacing element shall be indicated in the specification of the old element. + +Implementations of the previous release that now implement the current release shall continue to support usage of the deprecated attributes/classes as well as any new replacing attributes/classes, but not at the same time. As soon as the newer (replacing) attributes/classes are used, it may no longer be possible to also support usage of the deprecated elements or show correct values for the deprecated attributes. (E.g. when the type of an attribute is changed from integer to string). Once the replacing attribute/IOC is used, the old attribute/IOC may lose functionality and should not be used anymore. + +In case the deprecated or the replacing element was or is intended to have a multiplicity strictly greater than zero (mandatory to configure/report), the model elements should be declared with a multiplicity including zero, as only one of the deprecated and the replacement elements will be used at any one time. + +The deprecating procedure shall be used between releases. There is no need to follow it during the development of a single release, as long as the release is not yet frozen. + +## 5.3 Stereotype + +### 5.3.0 Description + +Subclause 5.1 listed the UML defined basic model elements. UML defined a stereotype concept allowing the specification of simple or complex user-defined model elements. + +This subclause lists all allowable stereotypes for this repertoire. + +The names of stereotypes shall be chosen such that they do not clash. + +For each stereotype model element listed, there are three parts. The first part contains its description. The second part contains its graphical notation examples and the third part contains the rule, if any, recommended for labelling or naming it. + +### 5.3.1 <> + +#### 5.3.1.1 Description + +It is a form or template representing a number of <>. It encapsulates attributes, links, methods (or operations), and interactions that are present in the represented <>. + +The semantics of a <> is that all behaviour of the <> is present in the represented <>. Since this class is simply a representation of other classes, this class cannot define its own behaviour other than those already defined by the represented <>. + +A particular <> can be represented by zero, one or more <>. For example, the ManagedElement <> can have MonitoredEntity <> and ManagedEntity <>. + +The attributes of the <> are accessible by the source entity that has an association with the <>. + +#### 5.3.1.2 Example + +This shows a <> named MonitoredEntity. It represents (or its constraints is that it represents) all NRM <> (e.g. GgsnFunction <>) whose instances are being monitored for alarm conditions. It is mandatory to use a Note to capture the constraint. + +![Diagram showing the graphical notation for a ProxyClass. A box labeled '«ProxyClass» MonitoredEntity' is connected by a dashed line to a note box containing the text 'It represents all NRM IOCs that can have alarms'.](c42e926097d01653b793c04b49e764b2_img.jpg) + +``` +graph LR; A["«ProxyClass» +MonitoredEntity"] -.-> B["It represents all NRM IOCs that can have alarms"]; +``` + +Diagram showing the graphical notation for a ProxyClass. A box labeled '«ProxyClass» MonitoredEntity' is connected by a dashed line to a note box containing the text 'It represents all NRM IOCs that can have alarms'. + +Figure 5.3.1.2-1: <> notation + +See Annex A for more examples that use <>. + +#### 5.3.1.3 Name style + +For <> name, use the same style as <> (see 5.3.2). + +### 5.3.2 <> + +#### 5.3.2.1 Description + +The <> is identical to UML *class* except that it does not include/define methods or operations. + +A UML *class* represents a capability or concept within the system being modelled. Classes have data structure and behaviour and relationships to other elements. + +This class can inherit from zero, one or multiple classes (multiple inheritances). + +See more on UML *class* in 10.2.1 of [1]. + +#### 5.3.2.2 Example + +This example shows an `AbcFunction` <>. + +![UML diagram showing the notation for an InformationObjectClass. It is a rectangular box with a double border. Inside the box, the top line contains the stereotype <> and the bottom line contains the class name AbcFunction.](2834bdd6eb8540277e609decbb924003_img.jpg) + +UML diagram showing the notation for an InformationObjectClass. It is a rectangular box with a double border. Inside the box, the top line contains the stereotype <> and the bottom line contains the class name AbcFunction. + +**Figure 5.3.2.2-1: <> notation** + +The following table captures the properties of this modelled element. + +**Table 5.3.2.2-1: <> properties** + +| Property name | Description | Legal values | +|------------------|------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| documentation | Contains a textual description of this modelled element.
Should refer (to enable traceability) to a specific requirement. | Any | +| isAbstract | Indicates if the class can be instantiated or is just used for inheritance. | True, False (default) | +| isNotifyable | Identifies the list of the supported notifications. | List of names of notification | +| supportQualifier | Identifies the required support of the class. See also subclause 6. | M, O (default), CM, CO, C | + +#### 5.3.2.3 Name style + +The name shall use UCC style. The name shall end with an underscore if it is an abstract class in the UIM. The name must not end with an underscore if it is a concrete class. + +WKA is treated as a word if used in a name. However, WKA shall be used as is (its letter case cannot be changed) except when it is the first word of the name; and if so, its first letter must be in upper case. + +Embedded underscore is not allowed except the name is for an Association class (see 5.4.1.) + +### 5.3.3 <> + +#### 5.3.3.1 Description + +The <> is modelled by a composite association where both ends are non-navigable. The source class is the composite and the target class is the component. The target instance is uniquely identifiable, within the namespace of the source entity, among all other targeted instances of the same target class and among other targeted instances of other classes that have the same <> composition with the source. + +The source class and target class shall each have its own naming attribute. + +The composite aggregation association relationship is used as the act of name containment providing a semantic of a whole-part relationship between the domain and the named elements that are contained, even if only by name. From the management perspective access to the part is through the whole. Multiplicity shall be indicated at both ends of the relationship. + +A target instance cannot have multiple <> with multiple source instances s, i.e. a target instance can not participate in or belong to multiple namespaces. + +#### 5.3.3.2 Example + +This shows that all instances of Class4 are uniquely identifiable within a Class3 instance's namespace. + +![UML Class Diagram showing a composite aggregation relationship between Class3 and Class4. Class3 is on the left with a multiplicity of 1, and Class4 is on the right with a multiplicity of *. The association is labeled <>. A solid black diamond is located at the Class3 end of the association line.](86b4670fc1a5a694821ee92b99c1209a_img.jpg) + +``` + +classDiagram + Class3 "1" *-- "*" Class4 : <> + classDiagram + class Class3 { + <> + } + class Class4 { + <> + } + +``` + +UML Class Diagram showing a composite aggregation relationship between Class3 and Class4. Class3 is on the left with a multiplicity of 1, and Class4 is on the right with a multiplicity of \*. The association is labeled <>. A solid black diamond is located at the Class3 end of the association line. + +Figure 5.3.3.2-1: <> notation + +#### 5.3.3.3 Name style + +It has no name so there is no name style. + +### 5.3.4 <> + +#### 5.3.4.1 Description + +It represents an attribute property type (see Table 5.2.1.1-1: Attribute properties). + +This repertoire uses two kinds of data types: predefined data types and user-defined data types. The former is defined in subclause 5.4.3. The latter is defined by the specification by authors using a <> model element. + +The names of predefined data types and user-defined data types must be chosen such that they do not clash. + +User-defined data types can be simple types containing one or more values of a single simple type like integer or string or they can be structured types containing one or more named attribute fields each having properties similar to an attribute as described in table 5.2.1.1-1. The individual attribute fields may have different property values e.g., different types, multiplicity or supportQualifier. A named attribute field itself can be of a simple or a structured data type. + +Structured data types could be embedded in any depth; however, they should not be embedded more than 3 levels, that is attribute-structuredType-structuredType-structuredType-simpleType. Reasons for avoiding deep embedding of structured types include: + +- Any construct that would be modeled by such deep structures can be modeled partly or fully by IOCs instead, thus avoiding deep structures. +- It is difficult to understand deep structured types, it is hard to follow their "type containment". +- Addressing in most contexts is based on Distinguished Names which does not allow addressing individual attribute fields. +- Filtering of attribute fields becomes complex. +- Usability problems on any human interface (GUI, CLI). + +The user-defined data types support the modelling of structured data types (see <> PLMNIId in 5.3.4.2). + +When an attribute is of a structured data type, attribute properties may be declared on multiple levels: declared for the attribute as a whole and also for each attribute field. As an attributed field itself may be of a structured data type, properties may be declared on 2, 3 or more levels. + +"Documentation" is relevant on the attribute or attribute field level where it is declared. Properties "multiplicity", "isOrdered", "isUnique", "type" and "allowedValues" are always relevant and should be enforced on the attribute or attribute field level where they are declared. + +The property "supportQualifier" always applies to the level where it is declared. However, the support for a model element is always conditional on the support of the higher level. E.g., if an attribute is optional but one of its fields is mandatory, that means the field is mandatory if the attribute itself is supported; if the attribute is not supported this results in none of its fields(subparts) being supported. + +For properties "isReadable", "isWritable", "isNotifyable" the following rules apply: + +- If a structured attribute specifies the property as False then the False value shall be used for the attribute and all its (descendant) attribute fields (if any). +- If a structured attribute specifies the property as True then the True value shall be used for the attribute and all its (descendant) attribute fields if and only if True is also specified for all of them. +- If a structured attribute specifies the property as True then the True value shall be used for the attribute and all its (descendant) attribute fields until a False value is specified for an attribute field. This attribute field and all (descendant) attribute fields shall have a False value. + +For the "isInvariant" property the following rules apply: + +- If a structured attribute specifies the property as True then the True value shall be used for the attribute and all its (descendant) attribute fields (if any). +- If a structured attribute specifies the property as False then the False value shall be used for the attribute and all its (descendant) attribute fields if and only if False is also specified for all of them. +- If a structured attribute specifies the property as False then the False value shall be used for the attribute and all its (descendant) attribute fields until a True value is specified for an attribute field. This attribute field and all (descendant) attribute fields shall have a True value. + +If an attribute has the property lifecycleStatus=Deprecated all its fields are also deprecated. If a data type has property lifecycleStatus=Deprecated all its fields (subparts) are also deprecated. + +When a user-defined or predefined data type is used to apply type (see property named type in Table 5.2.1.1-1: Attribute properties) information to a class attribute, the data type name is shown along with the class attribute. See Example below. + +When an attribute/field is defined with a datatype the relationship between them can be optionally established in the UML relationship diagram, e.g. for deeply nested datatypes. The relationship is shown as a relationship in the diagram between the parent attribute/field name and the datatype. The line includes the attribute/field. These diagrams shall be limited to one class and associated datatypes. + +#### 5.3.4.2 Example + +The following examples are two user-defined data types. + +The left-most user-defined data type is named `PLMNId`. It has two attributes. One is the Mobile Country Code (MCC) of predefined data type `String`. The other is the Mobile Network Code (MNC) of predefined data type `String` as well. + +The right-most user-defined data type is named `Xyz`. It has three attributes. The `attribute1` uses predefined data type `String`. The `attribute2` uses predefined data type `Integer`. The `attribute3` uses user-defined data type `PLMNId`. + +![UML diagrams showing two user-defined data types: PLMNId and Xyz.](8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg) + +The diagram shows two separate boxes representing user-defined data types. The left box is labeled «dataType» PLMNId and contains two attributes: mCC: String and mNC: String. The right box is labeled «dataType» Xyz and contains three attributes: attribute1: String, attribute2: Integer, and attribute3: PLMNId. + +UML diagrams showing two user-defined data types: PLMNId and Xyz. + +Figure 5.3.4.2-1: <> notations + +The following example shows a `ZClass` which has four attributes. Two attributes (i.e. `attribute1`, `attribute4`) use the user-defined data types (i.e. `PLMNId`, `Xyz`) and the other two attributes use the predefined data types. + +![UML diagram showing a ZClass with four attributes.](dd380ccd5aca1151074fede04826f1a4_img.jpg) + +The diagram shows a box labeled «InformationObjectClass» ZClass. It contains four attributes: attribute1: PLMNId, attribute3: String, attribute4: Xyz, and attribute2: Integer. + +UML diagram showing a ZClass with four attributes. + +Figure 5.3.4.2-2: Usage example of <> + +The third column of the following shows some of the properties of an attribute `attribute1` of `ZClass`. It shows the `attribute1` attribute property type is `PLMNId`, a user-defined data type. + +| | | | +|-------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------| +| attribute1 | It is a PLMN identifier. | type: PLMNId
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: None
isNullable: False | +|-------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------| + +#### 5.3.4.3 Name style + +For <> name, use the same style as <> (see 5.3.2). + +For <> attribute, use the same style as `Attribute` (see 5.2.1). + +### 5.3.5 <> + +#### 5.3.5.1 Description + +An enumeration is a data type. It contains sets of named literals that represent the values of the enumeration. An enumeration has a name. + +See 10.3.2 Enumeration of [1]. + +#### 5.3.5.2 Example + +This example shows an enumeration model element whose name is `Account` and it has four enumeration literals. The upper compartment contains the keyword `<>` and the name of the enumeration. The lower compartment contains a list of enumeration literals. + +Note that the symbol to the right of `<> Account` in the figure below is a feature specific to a particular modelling tool. It is recommended that modelling tool features should be used when appropriate. + +![UML diagram of an enumeration named Account. The top compartment contains the stereotype <> and the name Account. The bottom compartment contains four literals: CASH_ACCOUNT, STUDENT_ACCOUNT, SENIOR_ACCOUNT, and PREMIUM_ACCOUNT.](f1fbb1287d999c7034742de35bdab836_img.jpg) + +| | +|----------------------------------------------------------------------| +| <>
Account | +| CASH_ACCOUNT
STUDENT_ACCOUNT
SENIOR_ACCOUNT
PREMIUM_ACCOUNT | + +UML diagram of an enumeration named Account. The top compartment contains the stereotype <> and the name Account. The bottom compartment contains four literals: CASH\_ACCOUNT, STUDENT\_ACCOUNT, SENIOR\_ACCOUNT, and PREMIUM\_ACCOUNT. + +Figure 5.3.5.2-1: <> notation + +#### 5.3.5.3 Name style + +For `<>` name, use the same style as `<>` (see 5.3.2). + +For `<>` attribute (the enumeration literal), use the following rules: + +- Enumeration literal is composed of one or more words of upper case characters. Words are separated by the underscore character. + +### 5.3.6 <> + +#### 5.3.6.1 Description + +The `<>` stereotype represents one of a set of classes (when used as an information model element) or one of a set of data types (when used as an operation model element). + +This stereotype property, e.g., one out of a set of possible alternatives, is identical to the `{xor}` constraint (see 5.2.10). + +#### 5.3.6.2 Example + +Sometimes the specific kind of class cannot be determined at model specification time. In order to support such scenario, the specification is done by listing all possible classes. + +The following diagram lists 3 possible classes. It also shows a `<>` named `SubstituteObjectClass`. This scenario indicates that only one of the three related `<>` named `Alternative1ObjectClass`, `Alternative2ObjectClass`, `Alternative3ObjectClass` shall be realised. + +The `<>` stereotype represents one of a set of classes when used as an information model element. + +![UML diagram showing a choice class SubstituteObjectClass with three alternative object classes: Alternative1ObjectClass, Alternative2ObjectClass, and Alternative3ObjectClass.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +classDiagram + class SubstituteObjectClass { + <> + } + class Alternative1ObjectClass { + <> + } + class Alternative2ObjectClass { + <> + } + class Alternative3ObjectClass { + <> + } + SubstituteObjectClass "1" --> "1" Alternative1ObjectClass : +alternative1 + SubstituteObjectClass "1" --> "1" Alternative2ObjectClass : +alternative2 + SubstituteObjectClass "1" --> "1" Alternative3ObjectClass : +alternative3 + +``` + +UML diagram showing a choice class SubstituteObjectClass with three alternative object classes: Alternative1ObjectClass, Alternative2ObjectClass, and Alternative3ObjectClass. + +Figure 5.3.6.2-1: Information model element example using «choice» notation + +Sometimes the specific kind of data type cannot be determined at model specification time. In order to support such scenario, the specification is done by listing all possible data types. + +The following diagram lists 2 possible data types. It also shows a «choice» named ProbableCause. This scenario indicates that only one of the two «dataType» named IntegerProbableCause, StringProbableCause shall be realised. + +The «choice» stereotype represents one of a set of data types when used as an operations model element. + +![UML diagram showing a choice class ProbableCause with two alternative data types: IntegerProbableCause and StringProbableCause.](356eb99ab9489bbd647223390a913903_img.jpg) + +``` + +classDiagram + class ProbableCause { + <> + } + class IntegerProbableCause { + <> + probableCause : Integer + } + class StringProbableCause { + <> + probableCause : String + } + ProbableCause "1" --> "1" IntegerProbableCause : +probableCause1 + ProbableCause "1" --> "1" StringProbableCause : +probableCause2 + +``` + +UML diagram showing a choice class ProbableCause with two alternative data types: IntegerProbableCause and StringProbableCause. + +Figure 5.3.6.2-2: Operations model element example using «choice» notation + +#### 5.3.6.3 Name style + +For «choice» name, use the same style as «InformationObjectClass» (see 5.3.2). + +## 5.4 Others + +### 5.4.1 Association class + +#### 5.4.1.1 Description + +An association class is an association that also has class properties (or a class that has association properties). Even though it is drawn as an association and a class, it is really just a single model element. + +See 7.3.4 AssociationClass of [2]. + +Association classes are appropriate for use when an «InformationObjectClass» needs to maintain associations to several other instances of «InformationObjectClass» and there are relationships between the members of the associations within the scope of the "containing" «InformationObjectClass». For example, a namespace maintains a set of bindings, a binding ties a name to an identifier. A NameBinding «InformationObjectClass» can be modelled as an Association Class that provides the binding semantics to the relationship between an identifier and some other «InformationObjectClass» such as Object in the figure. This is depicted in the following figure. + +#### 5.4.1.2 Example + +![UML Class Diagram showing association class notation. A class '«InformationObjectClass» Name' is at the top, connected by a solid line with a black diamond to a class '«InformationObjectClass» NameBinding'. The association is labeled '«names»' and has multiplicities '1' at the top and '*' at the bottom. Below 'NameBinding' is a dashed line leading to a horizontal association between '«InformationObjectClass» Identifier' (multiplicity '1') and '«InformationObjectClass» Object' (multiplicity '1').](eb5677b570ab2a3e9d8f5d35ca5b8a4d_img.jpg) + +``` + +classDiagram + class NameBinding["«InformationObjectClass» NameBinding"] + class Name["«InformationObjectClass» Name"] + class Identifier["«InformationObjectClass» Identifier"] + class Object["«InformationObjectClass» Object"] + + Name "1" *-- "*" NameBinding : «names» + NameBinding -.-> Identifier + Identifier "1" -- "1" Object + +``` + +UML Class Diagram showing association class notation. A class '«InformationObjectClass» Name' is at the top, connected by a solid line with a black diamond to a class '«InformationObjectClass» NameBinding'. The association is labeled '«names»' and has multiplicities '1' at the top and '\*' at the bottom. Below 'NameBinding' is a dashed line leading to a horizontal association between '«InformationObjectClass» Identifier' (multiplicity '1') and '«InformationObjectClass» Object' (multiplicity '1'). + +Figure 5.4.1.2-1: Association class notation + +#### 5.4.1.3 Name style + +The name shall use the same style as in «InformationObjectClass» (see 5.3.2.3). + +### 5.4.2 Abstract class + +#### 5.4.2.1 Description + +It specifies a special kind of «InformationObjectClass» as the general model element involved in a generalization relationship (see 5.2.5). An abstract class cannot be instantiated. + +This modelled element has the same properties as class. See 5.3.2. + +#### 5.4.2.2 Example + +This shows that *Class5\_* is an abstract class. It is the base class for *SpecializedClass5*. + +![UML Class Diagram showing abstract class notation. A class '«InformationObjectClass» Class5_' is on the left, and a class '«InformationObjectClass» SpecializedClass5' is on the right. A solid line with an open triangle arrowhead points from 'SpecializedClass5' to 'Class5_', indicating inheritance.](9a159e2112eac7be06bdb97e84a0c49a_img.jpg) + +``` + +classDiagram + class Class5_["«InformationObjectClass» Class5_"] + class SpecializedClass5["«InformationObjectClass» SpecializedClass5"] + + SpecializedClass5 --|> Class5_ + +``` + +UML Class Diagram showing abstract class notation. A class '«InformationObjectClass» Class5\_' is on the left, and a class '«InformationObjectClass» SpecializedClass5' is on the right. A solid line with an open triangle arrowhead points from 'SpecializedClass5' to 'Class5\_', indicating inheritance. + +Figure 5.4.2.2-1: Abstract class notation + +#### 5.4.2.3 Name style + +For abstract class name, use the same style as «InformationObjectClass» (see 5.3.2). The name shall be in italics. In the UOM, its last character shall be an underscore + +### 5.4.3 Predefined data types + +#### 5.4.3.1 Description + +It represents the general notion of being a data type (i.e. a type whose instances are identified only by their values) whose definition is defined by this specification and not by the user (e.g. specification authors). + +This repertoire uses two kinds of data types: predefined data types and user-defined data types. The latter is defined in 5.3.4 <> and 5.3.5 <>. + +The following table lists the UML data types selected for use as predefined data type. + +**Table 5.4.3.1-1: UML defined data types** + +| Name | Description and reference | +|---------|----------------------------------| +| Boolean | See Boolean type of [7]. | +| Integer | See Integer type of [7]. | +| String | See PrintableString type of [7]. | + +The following table lists data types that are defined by this repertoire. + +**Table 5.4.3.1-2: Non-UML defined data types** + +| Name | Description and reference | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AttributeValuePair | This data type defines an attribute name and the attribute's value. | +| BitString | This data type is defined by Bit string of subclause 3 and subclause G.2.5 of [7]. | +| DateTime | This data type defines Date/Time Format, and it is protocol specific. | +| DN | This data type defines the DN (see Distinguished Name of [3]) of an object. It contains a sequence of one or more name components. The "initial subsequence" (note 1) of a DN is also a DN of an object.

Note 1: Suppose an object's DN is composed of a sequence of 4 name components, i.e. 1 st , 2 nd , 3 rd and 4 th components. The "initial subsequence" of this DN is composed of the 1 st , 2 nd and 3 rd components. | +| External | This data type is defined by another organization. | +| Real | This data type is defined by Real type of [7] | + +#### 5.4.3.2 Example + +![UML Class diagram showing a class named 'Class1' with attributes: identifier (DN), sourceTime (DateTime), measurementValue (Real), and suspectFlag (Boolean).](7728e2dd44c95d109debb1eb59e9b411_img.jpg) + +``` + +classDiagram + class Class1 { + identifier : DN + sourceTime : DateTime + measurementValue : Real + suspectFlag : Boolean + } + +``` + +UML Class diagram showing a class named 'Class1' with attributes: identifier (DN), sourceTime (DateTime), measurementValue (Real), and suspectFlag (Boolean). + +**Figure 5.4.3.2-1: Predefined data types usage** + +NOTE: Use of predefined data types is optional. Use of other means, to specify predefined data types, is allowed. + +#### 5.4.3.3 Name style + +It shall use the UCC style. + +# 6 Qualifiers + +This subclause defines the qualifiers applicable for model elements specified in this document, e.g. the IOC (see 5.3.2), the Attribute (see 5.2.1). The possible qualifications are M, O, CM, CO and C. Their meanings are specified in this subclause. This type of qualifier is called Support Qualifier (see supportQualifier of IOC in Table 5.3.2.2-1 and supportQualifier of attribute in Table 5.2.1.1-1). + +This subclause also defines the qualifiers applicable to various properties of a model element, e.g. see the IOC properties excepting IOC supportQualifier in Table 5.3.2.2-1 and attributes properties excepting attribute supportQualifier in Table 5.2.1.1-1. The possible qualifications are M, O, CM, CO and " - ". Their meanings are specified in this subclause. This type of qualifier is simply called Qualifier. + +Definition of M (Mandatory) qualification: + +- The capability (e.g. the Attribute named *abc* of an IOC named *Xyz*; the write property of Attribute named *abc* of an IOC named *Xyz*; the IOC named *Xyz*) shall be supported. + +Definition of O (Optional) qualification: + +- The capability may or may not be supported. + +Definition of CM (Conditional-Mandatory) qualification: + +- The capability shall be supported under certain conditions, specifically: + - When the qualification is CM, the capability shall have a corresponding constraint defined in the specification. If the specified constraint is met then the capability shall be supported. +- Definition of CO (Conditional-Optional) qualification: + - The capability may be supported under certain conditions, specifically: + - When the qualification is CO, the capability shall have a corresponding constraint defined in the specification. If the specified constraint is met then the capability may be supported. + +Definition of C (Conditional) qualification: + +- Used for items that has multiple constraints. Each constraint is worded as a condition for one kind of qualification such as M, O or "-". All constraints must be related to the same qualification. Specifically: + - Each item having the support qualifier C shall have the corresponding multiple constraints defined in the IS specification. If the specified constraint is met and is related to mandatory, then the item shall be supported. If the specified constraint is met and is related to optional, then the item may be supported. If the specified constraint is met and is related to "no support", then the item shall not be supported. + +NOTE: This qualification should only be used when absolutely necessary, as it is more complex to implement. + +Definition of SS (SS Conditional) qualification: + +- The capability shall be supported by at least one but not all solutions. + +Definition of " - " (no support) qualification: + +- The capability shall not be supported. + +Note that, in this clause, the term "support" refers to the support of standardized model elements by a specific implementation or instance of an agent. It cannot be assumed that unsupported standardized model elements are known to the agent. How an implementation is expected to treat unsupported standardized model elements is not specified, and the behaviour would likely be same as for other unknown or errant model elements. + +# --- 7 UML Diagram Requirements + +Classes and their relationships shall be presented in class diagrams. + +It is recommended to create: + +- An overview class diagram containing all object classes related to a specific management area (Class Diagram). + - The class name compartment should contain the location of the class definition (e.g., "Qualified Name") + - The class attributes should show the "Signature". (see subclause 7.3.44 of [2] for the signature definition); +- A separate inheritance class diagram in case the overview diagram would be overloaded when showing the inheritance structure (Inheritance Class Diagram); +- A class diagram containing the user defined data types (Type Definitions Diagram); +- Additional class diagrams to show specific parts of the specification in detail; +- State diagrams for complex state attributes. + +# Annex A (informative): Examples of using <> + +## A.1 First Example + +This shows a <> named YyyFunction. It represents all IOCs listed in the Note under the UML diagram. All the listed IOCs, in the context of this example, inherit from ManagedFunction IOC. + +The use of <> eliminates the need to draw multiple UML <> boxes, i.e. those whose names are listed in the Note, in the UML diagram. + +![UML diagram showing ManagedFunction as an InformationObjectClass, YyyFunction as a ProxyClass inheriting from it, and a note stating that YyyFunction represents AsFunction, AucFunction, and BgFunction.](94fd137860c16c8dfd75512f10161fe8_img.jpg) + +``` +classDiagram + class ManagedFunction { + <> + } + class YyyFunction { + <> + } + YyyFunction --|> ManagedFunction + note for YyyFunction "It represents AsFunction, AucFunction and BgFunction" +``` + +UML diagram showing ManagedFunction as an InformationObjectClass, YyyFunction as a ProxyClass inheriting from it, and a note stating that YyyFunction represents AsFunction, AucFunction, and BgFunction. + +Figure A.1-1: <> Notation Example A.1 + +## A.2 Second Example + +This shows a <> named YyyFunction. It represents all IOCs listed in the attached (or associated) Note. All the listed IOCs, in the context of this example, have link (internal and external) relations. + +This shows a <> InternalYyyFunction. It represents all IOCs listed in the attached (or associated) Note. + +This shows a <> Link\_a\_z and ExternalLink\_a\_z. They represent all IOCs listed in the attached (or associated) Note. + +![UML diagram showing ProxyClass relationships and their associated notes.](b904ac2472cab80892d1e783e6230d6e_img.jpg) + +``` +classDiagram + class Link_a_z["«ProxyClass» Link_a_z"] + class ExternalLink_a_z["«ProxyClass» ExternalLink_a_z"] + class InternalYyyFunction["«ProxyClass» InternalYyyFunction"] + class YyyFunction["«ProxyClass» YyyFunction"] + class ExternalYyyFunction["«ProxyClass» ExternalYyyFunction"] + + Link_a_z -.-> InternalYyyFunction + ExternalLink_a_z -.-> ExternalYyyFunction + InternalYyyFunction --> YyyFunction + ExternalYyyFunction --> YyyFunction +``` + +The diagram illustrates the <> notation. It features five class boxes and five associated note boxes. The classes are arranged in two rows. The top row contains «ProxyClass» Link\_a\_z and «ProxyClass» ExternalLink\_a\_z. The bottom row contains «ProxyClass» InternalYyyFunction, «ProxyClass» YyyFunction, and «ProxyClass» ExternalYyyFunction. Dashed lines connect Link\_a\_z to InternalYyyFunction and ExternalLink\_a\_z to ExternalYyyFunction. Solid lines connect InternalYyyFunction to YyyFunction and ExternalYyyFunction to YyyFunction. Each class has a note box connected to it by a solid line. The notes contain the following text: "It represents Link\_As\_Scsf and Link\_Bgcf\_Scsf." for Link\_a\_z, "It represents ABC, DEFG, HIJK." for ExternalLink\_a\_z, "It represents SlsFunction, CscfFunction and HlrFunction." for InternalYyyFunction, "It represents AsFunction and BgFunction." for YyyFunction, and "It represents Xyz, Zzz, IJKL." for ExternalYyyFunction. + +UML diagram showing ProxyClass relationships and their associated notes. + +Figure A.2-1: <> Notation Example A.2 + +# Annex B (normative): Attribute properties + +Table B.1 shows the impact of the "isWritable", "defaultValue" and "multiplicity" attribute properties on the behavior of managers and agents upon object creation, and on attribute values directly after object creation. See clause 3.1 for description of manager and agent. + +**Table B.1: Attribute properties** + +| isWritable | defaultValue | multiplicity $\geq 1$ | Impact of attribute properties on the behaviour of agents and managers upon object creation, and on attribute values directly after object creation | +|-------------------------------------|-------------------------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | The manager may provide a value.
If not provided, the agent shall set the value to the default value.
-> The attribute has the default value or some other value. | +| | | | The manager may provide a value.
If not provided, the agent shall set the value to the default value.
-> The attribute has the default value, or some other value.

Note, if "isInvariant: True", the attribute never has no value, even though this is allowed. | +| | | | The manager shall provide an attribute value.
-> The attribute has some value. | +| | | | The manager may provide a value.
If not provided, the agent shall not provide a value.
-> The attribute has some value, or no value. | +| | | | The manager shall not provide a value.
The agent shall set the value to the default value.
-> The attribute has the default value. | +| | | | The manager shall not provide a value.
The agent shall set the value to the default value.
-> The attribute has the default value.

Note, if "isInvariant: True", the attribute never has no value, even though this is allowed | +| | | | Not valid.
Reason:
The manager shall not provide a value.
The agent shall not provide a value.
-> The attribute has no value, which is an invalid state | +| | | | The manager shall not provide a value.
The agent shall not provide a value.
-> The attribute has no value.

Note, if "isInvariant: True", the attribute has invariantly no value, which is a valid state but may not make sense. | + +# Annex C (normative): Design patterns + +## C.1 Intervening class and Association class + +### C.1.1 Concept and definition + +Classes may be related via simple direct associations or via associations with related association classes. + +However, in situations where the relationships between a number of classes is complex and especially where the relationships between instances of those classes are themselves interrelated there may be a need to encapsulate the complexity of the relationships within a class that sits between the classes that are to be related. The term “intervening class” is used here to name the pattern that describes this approach. The name “intervening class” is used as the additional class “intervenes” in the relationships between other classes. + +The “intervening class” differs from the association class as the intervening class does break the association between the classes where as the association class does not but instead sits to one side. This can be seen in the following figure. A direct association between class A and C appears the same at A and C regardless of the presence or absence of an association class where as in the case of the “intervening class” there are associations between A and the “intervening class” B and C and the “intervening class” B. + +![UML diagrams illustrating four association forms: Basic association, Association Class, Intervening class (two variations).](b2ddf2a678bd20b1b491023eb1db6458_img.jpg) + +The diagram illustrates four different UML association patterns between Class A and Class C: + +- Basic association:** A direct association line between Class A and Class C. Multiplicity 0..1 is at Class A and 0..1 is at Class C. Role names +classA and +classC are shown. Note: "Note class A points at C and C points at A". +- Association Class:** A direct association line between Class A and Class C with multiplicity \* at both ends. Class B is an association class connected to the association line by a dashed line. Note: "Association where there is a need to represent the associations own features (i.e. that do not belong to any of the connected classes): +- Some behavior and state +- Some additional data related to the association +Note that class A points at C and C at A." +- "Intervening" class (Top):** Class A is associated with Class B (multiplicity \* to 0..1, role +classA to +classB). Class B is associated with Class C (multiplicity 0..1 to \*, role +classB to +classC). Note: "When there is a complex assembly of state/data bound to a number of associations." +- "Intervening" class (Bottom):** Class A is associated with Class B (multiplicity \* to 0..1, role +classA to +classB). Class B is associated with Class C (multiplicity 0..1 to \*, role +classB to +classC). Additionally, Class B has directed associations back to Class A and Class C. Note: "Note that Class A and C points to B and potentially B points to A and C." + +UML diagrams illustrating four association forms: Basic association, Association Class, Intervening class (two variations). + +Figure C.1.1-1: Various association forms + +The “intervening class” is essentially no different to any other class in that it may encapsulate attributes, complex behaviour etc. + +The following figure shows an instance view of both an association class form and an “intervening class” form for a complex interrelationship + +![UML Class Diagram illustrating the instance view of an 'intervening class'. The diagram shows ClassAInstance2ClassA, ClassBInstance1ClassB, ClassBInstance4ClassB, ClassBInstance3ClassB, ClassBInstance2ClassB, ClassAInstance1ClassA, ClassCInstance2ClassC, and ClassCInstance1ClassC. It includes an 'Association Class' note and an 'Intervening class' note.](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +**Association Class** +Many instances of association class, one per association instance. + +**"Intervening" class** +One instance of intervening class that captures complex association and intertwining between classes. Also captures behavior interaction such as protection switching and state (e.g. where class A and C are TPs and class B is an SNC). + +UML Class Diagram illustrating the instance view of an 'intervening class'. The diagram shows ClassAInstance2ClassA, ClassBInstance1ClassB, ClassBInstance4ClassB, ClassBInstance3ClassB, ClassBInstance2ClassB, ClassAInstance1ClassA, ClassCInstance2ClassC, and ClassCInstance1ClassC. It includes an 'Association Class' note and an 'Intervening class' note. + +Figure C.1.1-2: Instance view of "intervening class" + +The case depicted above does not show interrelationships between the relationships. A practical case from modeling of the relationships between Termination Points in a fixed network does show this relationship interrelationship challenge. In this case the complexity of relationship is between instances of the same class, the Termination Point (TP). The complexity is encapsulated in a SubNetworkConnection (SNC) class. + +#### **Simplified SNC and TP case** + +An SNC cannot exist without at least 2 TPs being related. + +![UML Class Diagram showing a simplified SNC and TP case. It depicts a TP class with a multiplicity of '*' and a role '+TP' connected to an SNC class with a multiplicity of '0..2' and a role '+sNC'.](409498e57b1f988b2b604d12cd997002_img.jpg) + +UML Class Diagram showing a simplified SNC and TP case. It depicts a TP class with a multiplicity of '\*' and a role '+TP' connected to an SNC class with a multiplicity of '0..2' and a role '+sNC'. + +Some simplifications: In this case TP and SNC model is assumed to be bidirectional only. The TPs have roles with respect to the SNC but these are ignored here. There are many other attributes and properties related to protection that are ignored here.. + +![UML Class Diagram showing SNC intervening in TP-TP relationship. It depicts four IPInstance classes (IPInstance1IP, IPInstance2IP, IPInstance3IP, IPInstance4IP) all connected to a central SNCInstanceIP class via roles labeled '-tP'.](3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg) + +UML Class Diagram showing SNC intervening in TP-TP relationship. It depicts four IPInstance classes (IPInstance1IP, IPInstance2IP, IPInstance3IP, IPInstance4IP) all connected to a central SNCInstanceIP class via roles labeled '-tP'. + +**"Intervening" class** +One instance of intervening class that captures complex association and intertwining between classes. Also captures behavior interaction such as protection switching and state + +Figure C.1.1-3: SNC intervening in TP-TP relationship + +The SNC also encapsulates the complex behaviour of switching and path selection as depicted below. + +![UML class diagram showing complex relationship interrelationships between SncAssociationInstance classes and ProtectionInstanceProtection. It includes association classes with protection switching rules and complex creation transaction interrelationships.](08c7a76a7786bd08b99dd4cb41583ef4_img.jpg) + +The diagram illustrates the following classes and relationships: + +- SncAssociationInstance5SncAssociation**: Attributes include tp = TPInstance1 and tp = TPInstance3. +- SncAssociationInstance4SncAssociation**: Attributes include tp = TPInstance1 and tp = TPInstance4. +- SncAssociationInstance3SncAssociation**: Attributes include tp = TPInstance2 and tp = TPInstance3. +- SncAssociationInstance25SncAssociation**: Attributes include tp = TPInstance2 and tp = TPInstance4. +- ProtectionInstanceProtection**: A central class associated with the SncAssociationInstance classes. +- Association class**: Labeled "With protection switching rule and state." and "There is a complex creation transaction interrelationship". +- IPInstance1IP**, **IPInstance2IP**, **IPInstance3IP**, **IPInstance4IP**: All have the attribute tp = Entries[2]. These are connected to the SncAssociationInstance classes via dashed lines representing complex relationships. + +UML class diagram showing complex relationship interrelationships between SncAssociationInstance classes and ProtectionInstanceProtection. It includes association classes with protection switching rules and complex creation transaction interrelationships. + +Figure C.1.1-4: Complex relationship interrelationships + +### C.1.2 Usage in the non-transport domain + +The choice of association class pattern or intervening class pattern is on a case-by-case basis. + +The transport domain boundary is highlighted in the following figure. + +![Diagram highlighting the boundary between transport and non-transport domains. It shows a Management Environment, Network Elements (NE with wireless access, Wire-line NE), and various connection points (CTP, PTP) across these domains.](9ff1b32449ea068bba9647d71904bd59_img.jpg) + +The diagram shows the following components and boundaries: + +- Management Environment**: A box at the top. +- Legend**: + - Network Element (orange box) + - Link entity (connectivity e.g. X2) (blue box) + - Topological Link (orange line) + - Based on Connection Termination Point concept (dashed green box) + - Based on Physical Termination Point concept (dashed purple box) + - 3GPP Managed Function (blue box) + - Connection Termination Point (green box) + - Physical Termination Point (purple box) + - Association/relationship (double-headed arrow) + - Optical fiber (blue line) +- Boundary**: A dashed red line separates the "non-transport domain" (top) from the "transport domain" (bottom). +- NE with wireless access**: Contains a 3GPP Managed Function (e.g. eNodeB function) connected to a Connection Termination Point (CTP) and a Physical Termination Point (PTP). +- Wire-line NE**: Contains a Connection Termination Point (CTP) and a Physical Termination Point (PTP). +- NE with wireless access** (right): A separate Network Element box. + +Diagram highlighting the boundary between transport and non-transport domains. It shows a Management Environment, Network Elements (NE with wireless access, Wire-line NE), and various connection points (CTP, PTP) across these domains. + +Figure C.1.2-1: Highlighting the boundary between transport and non-transport domains + +### C.1.3 Usage in the transport domain + +The following guidelines must be applied to the models of the “transport domain”. + +When considering interrelationships between classes the following guidelines should be applied: + +- If considering all current and recognised potential future cases it is expected that the relationship between two specific classes will be 0..1:0..1 then a simple association should be used + - This may benefit from an association class to convey rules and parameters about the association behaviour in complex cases. + +- If there is recognised potential for cases currently or in future where there is a 0..\*:0..\* between two specific classes then intervening classes should be used to encapsulate the groupings etc. so as to convert it to 0..1:n..\*. + - Note that the 0..1:n..\* association may benefit from an association class to convey rules and parameters about the association behaviour in complex cases but in the instance form this can probably be ignored or folded into the intervening class +- In general it seems appropriate to use an association class when the properties on the relationship instance cannot be obviously or reasonably folded into one of the classes at either end of the association and when there is no interdependency between association instances between a set of instances of the classes. + +An example of usage of intervening class is the case of the TP-TP (TerminationPoint) relationship (0..\*:0..\*) where the SNC (SubNetworkConnection) is added as the intervening class between multiple TPs, i.e. TP-SNC. Note that TP-SNC actually becomes 0..2:n..\* due to directionality encapsulation. + +Considering the case of the adjacency relationship between PTPs it is known that although the current common cases are 1:1 there are some current and many potential future case of 0..\*:0..\* and hence a model that has an intervening class, i.e. the TopologicalLink, should be used. + +For a degenerate instance cases of 0..\*:0..\* that happens to be 0..1:0..1 the intervening class pattern should still be used: + +- • Using the 0..1:0..1 direct association in this degenerate case brings unnecessary variety to the model and hence to the behaviour of the application (the 0..1:n..\* model covers the 0..1:0..1 case with one single code form clearly) +- • An instance of the 0..1:0..1 model may need to be migrated to 0..1:n..\* as a result of some change in the network forcing an unnecessary administrative action to transition the model form where as in the 0..1:n..\* form requires no essential change. + +## --- C.2 Use of “ExternalXyz” class + +This subclause will be completed for the next release. + +--- + +Annex D (informative): +Void + +# --- Annex E (normative): <> stereotype definition + +## E.1 Description + +It is the descriptor for a set of management capabilities. + +The <> is an extension of UML *class*. See Annex [F] for the differences between <> and <>. + +See more on UML *class* in 10.2.1 of [1]. + +## E.2 Example + +This sample shows an AlarmList <>. + +![UML class diagram showing the <> stereotype notation for AlarmList.](eb1a67ebd688e354edaacb7ec2abf5ad_img.jpg) + +A UML class diagram for a class named 'AlarmList'. The class is represented by a rectangle divided into three compartments. The top compartment contains the stereotype name '«SupportIOC»' on the first line and the class name 'AlarmList' on the second line. The middle and bottom compartments are currently empty. + +UML class diagram showing the <> stereotype notation for AlarmList. + +<> notation + +## E.3 Name style + +For <> name, use the same style as <> (see subclause 5.3.2). + +# --- Annex F (normative): + +## Application of <> and <> + +The <> and <> are stereotypes. These two stereotypes serve similar purpose in that each is a named set of network resource properties. However, their applications, in the context of supporting network management over Itf-N or through the use of management services, can be different. This Annex highlights their similarities and differences of such application. + +| | <> | <> | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Can it be an abstract class? | Yes | Yes | +| Can it be a concrete class? | Yes | Yes | +| Can it inherit from <>? | Yes | No, except for <> Top. | +| Can it inherit from <>? | No | Yes | +| Can it be name-contained by <>? | Yes | Yes | +| Can it be name-contained by <>? | No | Yes | +| Can an instance have a DN? | <> must be a class of a naming-tree meaning all its instances must have a DN. | <> may be used by specification author for a class within a naming-tree. If so, it means that all its instances will have a DN. | +| Can either 1) IRPManager use operations of Basic CM IRP [9] and Bulk CM IRP [10] or 2) MnS consumer use the Provisioning operations [17] and [16] to access the information in an instance? | Either 1) IRPManager can use the Basic CM IRP and Bulk CM IRP operations or 2) MnS consumer can use the provisioning operations to access information of all <> defined in all NRM [15], in accordance to the qualifier values of the <>. |

Either 1) IRPManager can use the Basic CM IRP and Bulk CM IRP operations to access information of instances of <<SupportIOC>> defined in their respective Interface IRP (i.e. Basic CM IRP or Bulk CM IRP), in accordance to the qualifier values of the <<SupportIOC>> or 2) MnS consumer can use the provisioning operations to access information of instances of <<SupportIOC>> specified in [16] and [17] in accordance to the qualifier values of the <<SupportIOC>>.

Neither 1) IRPManager can use the Basic CM IRP and Bulk CM IRP operations to access information of instances of <<SupportIOC>> not defined in their respective Interface IRP (i.e. Basic CM IRP or Bulk CM IRP) nor 2) MnS consumer can use the Provisioning operations to access information of instances of <<SupportIOC>> not defined in [16] and [17]

| +| Can either 1) IRPManager use operations of Interface IRP, except Basic CM IRP [9] and Bulk CM IRP [10] (e.g. Alarm IRP [11]), or 2) MnS consumer use non Provisioning operations (e.g. fault supervision operations [14] and [16]) to access the information? | No |

Either 1) IRPManager can use the Interface IRP operations to access information of <<SupportIOC>> defined in their respective Interface IRP, in accordance to qualifier values of the <<SupportIOC>> or 2) . MnS consumer can use the Provisioning operations to access information of instances of <<SupportIOC>> specified in [16] and [17] in accordance to the qualifier values of the <<SupportIOC>>.

Neither 1) IRPManager can not use the Interface IRP operations to access information of <<SupportIOC>> not defined in their respective Interface IRP, nor 2) MnS consumer can not use the Provisioning operations to access information of instances of <<SupportIOC>> not defined in [16] and [17].

| + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Can either IRPManager or MnS consumer receive information via Notification [12] whose objectClass and objectInstance parameters carry the instance DN? | Yes.
The types of notification emitted are shown by the Notification Table associated with the class definition. | Yes if <<SupportIOC>> is a class of a naming-tree.
The types of notification emitted are shown by the Notification Table associated with the class definition.

No if <<SupportIOC>> is not a class of a naming-tree. | +| Measurement [13] | Measurements can be associated with <<InformationObjectClass>> instances. | Measurements can be associated with <<SupportIOC>> instances if <<SupportIOC>> class is used in a naming-tree. | + +# Annex G(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 | +| 2013-01 | | | | | Fixed layout problems | 11.0.0 | 11.0.1 | +| 2013-03 | | | | | Fixed title of the spec by removing a semi colon | 11.0.1 | 11.0.2 | +| 2013-06 | SA#60 | SP-130304 | 001 | - | Model Repertoire introduce CR S5vTMFa354 | 11.0.2 | 11.1.0 | +| 2014-09 | SA#65 | SP-140597 | 002 | - | Introduce the agreed result of MSDO JWG Model Alignment work | 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 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-12 | SA#74 | SP-160855 | 0003 | - | B | Add missing Annex | 14.0.0 | +| 2017-04 | | | | | | Editorial fixes (MCC) | 14.0.1 | +| 2018-06 | SA#80 | SP-180422 | 0007 | - | A | Clarify the use of datatype | 14.1.0 | +| 2018-06 | SA#80 | SP-180423 | 0015 | 1 | A | Clarification and removal of text | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2018-12 | SA#82 | SP-181042 | 0016 | 1 | F | Add producer - consumer interaction to Annex B | 15.1.0 | +| 2018-12 | SA#82 | SP-181042 | 0017 | 1 | F | Add producer - consumer interaction to Annex F | 15.1.0 | +| 2018-12 | SA#82 | SP-181042 | 0018 | 1 | F | Update example of the generalization relationship | 15.1.0 | +| 2018-12 | SA#82 | SP-181044 | 0019 | 2 | D | Inconsistent definition of composition | 16.0.0 | +| 2018-12 | SA#82 | SP-181044 | 0020 | - | C | Make the use of roles optional | 16.0.0 | +| 2018-12 | SA#82 | SP-181044 | 0021 | - | C | Make the use of the visibility symbol optional | 16.0.0 | +| 2019-03 | SA#83 | SP-190132 | 0023 | 1 | A | Removal of reference to a temporary joint working group | 16.1.0 | +| 2019-06 | SA#84 | SP-190377 | 0028 | 1 | A | Correct style for Definition | 16.2.0 | +| 2019-12 | SA#86 | SP-191159 | 0035 | - | F | Add passedById and other updates | 16.3.0 | +| 2019-12 | SA#86 | SP-191172 | 0036 | 4 | F | Update attribute properties table in clause 5.2.1.1 | 16.3.0 | +| 2020-03 | SA#87E | SP-200172 | 0037 | - | F | Correct reference to NOTE in attribute properties table in clause 5.2.1.1 | 16.4.0 | +| 2022-03 | SA#95e | SP-220179 | 0039 | 1 | F | Specifying multivalue attributes | 16.5.0 | +| 2022-03 | SA#95e | SP-220186 | 0040 | - | F | Clarify definition of AllowedValues | 17.0.0 | +| 2022-06 | SA#96 | SP-220510 | 0042 | 1 | A | Clarification of property defaultValue | 17.1.0 | +| 2022-12 | SA#98e | SP-221170 | 0047 | - | A | Correct the wrong example for Generalization relationship notation | 17.2.0 | +| 2022-12 | SA#98e | SP-221168 | 0048 | 2 | F | Clarify definitions of attribute properties | 17.2.0 | +| 2022-12 | SA#98e | SP-221189 | 0045 | 1 | B | Deprecating model elements | 18.0.0 | +| 2023-03 | SA#99 | SP-230212 | 0050 | 1 | F | Deprecate passedById | 18.1.0 | +| 2023-06 | SA#100 | SP-230658 | 0053 | 3 | A | Clarifying multilevel attribute properties | 18.2.0 | +| 2023-06 | SA#100 | SP-230650 | 0056 | 1 | A | Move Attribute definitions to UML repertoire | 18.2.0 | +| 2023-07 | SA#100 | | | | | Fixing CR implementation in definitions clause | 18.2.1 | +| 2023-08 | | | | | | Re-upload of the specification due to corrupt file in the server | 18.2.2 | +| 2023-09 | SA#101 | SP-230943 | 0057 | 1 | A | Update DateTime definition R18 | 18.3.0 | +| 2023-09 | SA#101 | SP-230945 | 0059 | 1 | A | Clarifying isInvariant true R18 | 18.3.0 | +| 2023-12 | SA#102 | SP-231486 | 0079 | 1 | A | Clarifying Terminology R18 | 18.4.0 | +| 2023-12 | SA#102 | SP-231494 | 0082 | 1 | F | Rel-18 CR 32.156 Add missing definition of node | 18.4.0 | +| 2023-12 | SA#102 | SP-231494 | 0084 | 1 | F | Rel-18 CR TS 32.156 Supplement the specification for establishing a relationship between <> and model elements in UML class diagram | 18.4.0 | +| 2023-12 | SA#102 | SP-231494 | 0088 | 1 | F | Rel-18 CR TS 32.156 Clarification on predefined dataType and example | 18.4.0 | +| 2023-12 | SA#102 | SP-231494 | 0089 | 1 | D | Rel-18 CR 32.156 Editorial clean up | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/32_series/32157/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32157/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4de7dd97b9337b3aaf072e746405ad520d5d45de --- /dev/null +++ b/marked/Rel-18/32_series/32157/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b42d116d8c2d814c86377d52a84e0f5d4ef04fd6b66457e5edf7e3dd2ea4cb7 +size 9370 diff --git a/marked/Rel-18/32_series/32157/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32157/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..befa7d0aab7a27d907df9a48accf6d9115609306 --- /dev/null +++ b/marked/Rel-18/32_series/32157/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9faff289c269ff2b0f41d2267933e4cc43c36969d345e79d9a3b32ee4d7b5dbd +size 5420 diff --git a/marked/Rel-18/32_series/32157/raw.md b/marked/Rel-18/32_series/32157/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4a4d80174cb609efecd3dd2a3d001485c12f28a0 --- /dev/null +++ b/marked/Rel-18/32_series/32157/raw.md @@ -0,0 +1,990 @@ + + +# 3GPP TS 32.157 V18.0.0 (2024-04) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' in smaller letters below the logo. + +3GPP logo + +## Keywords + +--- + +Information Service template, 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 + +--- + + + +## --- **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. + +© 2024, 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 +LTETM 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 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Information Service (IS) template..... | 6 | +| 4.1 General ..... | 6 | +| 4.2 Template for NRM IRP IS ..... | 7 | +| 4.3 Template for Interface IRP IS ..... | 15 | +| Annex A (informative): Change history..... | 30 | + +# --- 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 contains the template to be used for the production of all Integration Reference Point (IRP) Information Service (IS) specifications for Converged 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 TS 32.156: "Telecommunication management; Fixed Mobile Convergence (FMC) Model Repertoire". +- [5] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [6] ITU-T Recommendation M.3020 (07/2011): "Management interface specification methodology" – Annex E "Information type definitions – type repertoire". + +# 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: + +**IRP Agent:** See 3GPP TS 32.150 [3]. + +**IRP Manager:** See 3GPP TS 32.150 [3]. + +## 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 [3] and the following apply: + +| | | +|-----|----------------------------------| +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| OMG | Object Management Group | +| UML | Unified Modelling Language (OMG) | + +# 4 Information Service (IS) template + +## 4.1 General + +The present document contains the templates to be used for the production of all Integration Reference Point (IRP) Information Service (IS) specifications for Converged Management. + +Clause 4.2 is applicable for NRM IRP IS specifications. + +Clause 4.3 is applicable for Interface IRP IS specifications. + +The IS template uses qualifiers M, O, CM, CO and C. The semantics of these qualifiers are defined in [4]. + +The IS template uses type definition as one characteristic to describe class attributes and operation/notification parameters. The valid type definitions that can be used and their semantics are defined in [4]. + +Usage of fonts shall be according to the following table. + +| Item | Font | +|----------------------|-------------------------------------------------------| +| Class names | Courier New | +| Attribute names | Courier New | +| Operation names | Courier New | +| Parameter names | Courier New | +| Assertion names | Courier New | +| Notification names | Courier New | +| Exception names | Courier New | +| State names | Arial | +| Matching Information | Courier New | +| Information Type | Courier New | +| Legal Values | Courier New | +| NOTE: | These font requirements do not apply to UML diagrams. | + +## 4.2 Template for NRM IRP IS --- + +### W1 Scope + +*The following quoted text is relevant for all NRM IRP ISs. It shall be copied as the first two paragraphs of this clause in the NRM IRP IS specification. IRP IS author may add additional paragraph(s) if necessary.* + +" + +The present document specifies the <> (where <> shall be substituted by the name of the NRM IRP IS concerned such as 'HNS', 'E\_UTRAN', 'GERAN') 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. + +" + +--- + +### W2 References + +*The following text from the standard 3GPP TS template shall be copied into the NRM IRP IS specification, followed by the TS/TR references used in the specification:* + +" + +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] ... + +[2] ... + +... + +" + +--- + +### W3 Definitions and abbreviations + +*The following text from the standard 3GPP TS template shall be copied into the NRM IRP IS specification, completed by the definitions and abbreviations used in the specification:* + +" + +### W3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. For terms and definitions not found here, please refer to 3GPP TS . A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1] and . + +: . + +### W3.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]. + + + +" + +### W4 Model + +### W4.1 Imported and associated information entities + +#### W4.1.1 Imported information entities and local labels + +*This clause identifies a list of information entities (e.g. information object class, interface, attribute) that have been defined in other specifications and that are imported in the present (target) specification. All imported entities shall be treated as if they are defined locally in the target specification. One usage of import is for inheritance purpose.* + +*Each element of this list is a pair (label reference, local label). The label reference contains the name of the original specification where the information entity is defined, the information entity type and its name. The local label contains the name of the information entity that appears in the target specification, and the entity name in the local label shall be kept identical to the name defined in the original specification. The local label can then be used throughout the target specification instead of that which appears in the label reference.* + +*This information is provided in a table. An example of such a table is given here below:* + +| Label reference | Local label | +|----------------------------------------------------|-------------| +| 3GPP TS 32.622 [xy], information object class, Top | Top | + +#### W4.1.2 Associated information entities and local labels + +*This clause identifies a list of information entities (e.g. information object class, interface, attribute) that have been defined in other specifications and that are associated with the information entities defined in the present (target) specification. For the associated information entity, only its properties (e.g., DN (see 5.2.2 of 32.156 [4]), attribute (see 5.2.1 of 32.156 [4]) of an instance of the associated information entity) used as associated information needs to be supported locally in the target specification.* + +*Each element of this list is a pair (label reference, local label). The label reference contains the name of the original specification where the information entity is defined, the information entity type and its name. The local label contains the name of the information entity that appears in the target specification. The local label can then be used throughout the target specification instead of that which appears in the label reference.* + +*This information is provided in a table. An example of such a table is given here below:* + +| Label reference | Local label | +|---------------------------------------|-------------| +| 3GPP TS 28.705 [12], IOC, HSSFunction | HSSFunction | + +### W4.2 Class diagram + +#### W4.2.1 Relationships + +*This first set of diagrams represents all classes defined in this IS with all their relationships and all their attributes, including relationships with imported information entities (if any). These diagrams shall contain class cardinalities (for associations as well as containment relationships) and may also contain role names. These shall be UML compliant class diagrams (see also [4]).* + +*Characteristics (attributes, relationships) of imported information entities need not to be repeated in the diagrams. Allowable classes are specified in [4].* + +*Use this as the first paragraph: "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."* + +#### W4.2.2 Inheritance + +*This second set of diagrams represents the inheritance hierarchy of all classes defined in this specification. These diagrams do not need to contain the complete inheritance hierarchy but shall at least contain the parent classes of all classes defined in the present document. By default, a class inherits from the class "top".* + +*Characteristics (attributes, relationships) of imported classes need not to be repeated in the diagrams.* + +*NOTE: some inheritance relationships presented in clause W4.2.2 can be repeated in clause W4.2.1 to enhance readability.* + +*Use "This subclause depicts the inheritance relationships." as the first paragraph.* + +### W4.3 Class definitions + +*Each class is defined using the following structure.* + +*Inherited items (attributes etc.) shall not be shown, as they are defined in the parent class(es) and thus valid for the subclass.* + +#### W4.3.a InformationObjectClassName + +*InformationObjectClassName is the name of the information object class.* + +*The "a" represents a number, starting at 1 and increasing by 1 with each new definition of a class.* + +##### W4.3.a.1 Definition + +*This clause is written in natural language. The clause refers to the class itself.* + +*Optionally, information on traceability back to one or more requirements supported by this class can be defined here, in the following form:* + +| Referenced TS | Requirement label | Comment | +|---------------------|-------------------|------------------------| +| 3GPP TS 32.xyz [xy] | REQ-SM-CON-23 | Optional clarification | +| 3GPP TS 32.xyz [xy] | REQ-SM-FUN-11 | Optional clarification | + +##### W4.3.a.2 Attributes + +*This clause presents the list of attributes, which are the manageable properties of the class. Each attribute is characterised by some of the attribute properties (see Table 1 of [4]), i.e. supportQualifier, isReadable, isWritable, isInvariant and isNotifyable.* + +*The legal values and their semantics for attribute properties are defined in [4].* + +*This information is provided in a table.* + +*An example below indicates* + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| eNodeBId | M | M | - | M | M | + +Another example below indicates that the attribute *password1* is not readable, is writable, is not an invariant and no *notifyAttributeValueChange* will be emitted when the attribute value is changed. + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| password1 | O | - | M | - | - | + +Another example below indicates that the attribute *password2* and *password1* (in example above) has same qualifiers for the shown properties except that of *isReadable*. In the case of *password1*, the standard specification determines the qualifier to be *M*, i.e. it is readable. In the case of *password2*, the standard specification does not make a determination. The vendor would make the determination if the attribute is readable or not readable. + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| password2 | O | O | M | - | - | + +In case there is one or more attributes related to role (see section 5.2.9 of [4]), the attributes related to role shall be specified at the bottom of the table with a divider "Attribute related to role", as shown in the following example: + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| aTMChannelTerminationPointId | M | M | - | M | M | +| ... | | | | | | +| ... | | | | | | +| Attribute related to role | | | | | | +| theATMPathTerminationPoint | M | M | - | - | M | +| theIubLink | M | M | - | - | M | + +This clause shall state "None." when there is no attribute to define. + +##### W4.3.a.3 Attribute constraints + +This clause presents constraints for the attributes, and one use is to present the predicates for conditional qualifiers (CM/CO). + +This information is provided in a table. An example of such a table is given here below: + +| Name | Definition | +|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| pci CM write qualifier | Centralized PCI assignment (see TS 32.500, ref [xy] clause 6.1.6) is supported. | +| pciList CM support qualifier | Distributed PCI assignment (see TS 32.500, ref [xy] clause 6.1.6) is supported. | +| partOfSectorPower CM support qualifier | The IOC SectorEquipmentFunction is used. | +| attributeX max value | The value of attributeX shall be within the specified value range but may never be higher than the value of attributeY. | + +This clause shall state "None." when there is no attribute constraint to define. + +##### W4.3.a.4 Notifications + +This clause, for this class, presents one of the following options: + +- The class defines (and independent from those inherited) the support of a set of notifications that is identical to that defined in clause W4.5. In such case, use "The common notifications defined in clause W4.5 are valid for this class, without exceptions or additions." as the lone sentence of this clause. +- The class defines (and independent from those inherited) the support of a set of notifications that is a superset of that defined in clause W4.5. In such case, use "The common notifications defined in clause W4.5 are valid for + +*this IOC. In addition, the following set of notification is also valid." as the lone paragraph of this clause. Then, define the 'additional' notifications in a table. See clause W4.5 for the notification table format.* + +- c) The class defines (and independent from those inherited) the support of a set of notifications that is not identical to, nor a superset of, that defined in clause W4.5. In such case, use "The common notifications defined in clause W4.5 are not valid for this IOC. The set of notifications defined in the following table is valid." as the lone paragraph of this clause. Specify the set of notifications in a table. See clause W4.5 for the notification table format.* +- d) The class does not define (and independent from those inherited) the support of any notification. In such case, use "There is no notification defined." as the lone sentence of this clause.* + +*The notifications identified (i.e. option-a, option-b and option-c above) in this clause are notifications that can be emitted across the Itf-N, where the "object class" and "object instance" parameters of the notification header (see note 2) of these notifications identifies an instance of the class (or its direct or indirect derived class) defined by the encapsulating clause (i.e. clause W4.3.a).* + +*The notifications identified (i.e. option-a and option-b above) in this clause, may originate from implementation object(s) whose identifier may or may not be the same as that carried in the notification parameters "object class" and "object instance". Hence the identification of notifications in this clause does not imply nor identify those notifications as being originated from an instance of the class (or its direct or indirect derived class) defined by the encapsulating clause (i.e. clause W4.3.a).* + +*This clause shall state "This class does not support any notification." (see option-c) when there is no notification defined for this class. (Note that if its parent class has defined some notifications, the implementation of this class is capable of emitting those inherited defined notifications.)* + +*The notification header is defined in the notification IRP Information service TS 32.302 [5].* + +*The qualifier of a notification, specified in Notification Table, indicates if an implementation can generate a notification carrying the DN of the subject class. The qualifier of a notification, specified in an Interface IRP, indicates if an implementation of the Interface IRP can generate such notification in general.* + +*An IRPManager can receive notification-XYZ that carries DN (the "object class" and "object instance") of class-ABC instance if and only if:* + +- a) The class-ABC Notification Table defines the notification-XYZ and* +- b) The class-ABC instance implementation supports this notification-XYZ and* +- c) An Interface IRP defines the notification-XYZ and* +- d) The Interface IRP implementation supports this notification-XYZ.* + +##### W4.3.a.5 State diagram + +*This subclause contains state diagrams. A state diagram of an information object class defines permitted states of this information object class and the transitions between those states. A state is expressed in terms of individual attribute values or a combination of attribute values or involvement in relationships of the information object class being defined. This shall be a UML compliant state diagram.* + +*This subclause shall state "None." when there is no State diagram defined.* + +### W4.4 Attribute definitions + +#### W4.4.1 Attribute properties + +It has a lone paragraph "The following table defines the properties of attributes that are specified in the present document. " + +Each information attribute is defined using the following structure. + +Inherited attributes shall not be shown, as they are defined in the parent class(es) and thus valid for this class. + +An attribute has properties (see Table 1 of [4]). Some properties of an attribute are defined in W4.3.a.2 (e.g. Support Qualifier). The remaining properties of an attribute (e.g. documentation, default value) are defined here. + +The information is provided in a table. In case a) attributes of the same name are specified in more than one class and b) the attributes have different properties, then the attribute names (first column) should be prefixed with the class name followed by a period. + +An example is given below: + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------|------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| xyzld | It identifies ...
allowedValues: ... | type: Integer
multiplicity: ...
isOrdered: ...
isUnique: ...
defaultValue: ...
isNullable: False | +| Abc.state | It indicates ...

allowedValues:
"ON": the state is on;
"OFF": the state is off. | type: <>
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| Zyz.state | It indicates ...

allowedValues:
"HIGH": the state is high;
"MEDIUM": the state is medium;
"LOW": the state is low. | type: <>
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| abc | It defines...

allowedValues: ... | type: ...
multiplicity: ...
isOrdered: ...
isUnique: ...
defaultValue: ...
isNullable: ... | + +In case there is one or more attributes related to role (see section 5.2.9 of [4]), the attributes related to role shall be specified at the bottom of the table with a divider "Attribute related to role". See example below. + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------------|-----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| abc | It defines...

allowedValues: ... | type: <>
multiplicity: ...
isOrdered: ...
isUnique: ...
defaultValue: ...
isNullable: ... | +| Attribute related to role | | | +| aEnd | It defines...

allowedValues: Values to be conformant to TS 32.300 [xy] ... | type: DN
multiplicity: ...
isOrdered: ...
isUnique: ...
defaultValue: ...
isNullable: False | + +*This clause shall state "None." if there is no attribute to define.* + +#### W4.4.2 Constraints + +*This clause indicates whether there are any constraints affecting attributes. Each constraint is defined by a triplet (propertyName, affectedAttributes, propertyDefinition). PropertyDefinitions are expressed in natural language.* + +*An example is given here below:* + +| Name | Affected attribute(s) | Definition | +|----------------------|-----------------------|-------------------------------------------------------------| +| inv_TimerConstraints | ntfTimeTickTimer | The ntfTimeTickTimer is lower than or equal to ntfTimeTick. | + +*This clause shall state "None." if there is no constraint.* + +### W4.5 Common notifications + +*This clause presents notifications that can be referred to by any class defined in the specification. This information is provided in tables.* + +#### W4.5.1 Alarm notifications + +*The following quoted text shall be copied as the only paragraph of this clause.* + +"This clause presents a list of notifications, defined in [x], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [y], shall capture the DN of an instance of a class defined in this specification." + +*The information is provided in a table. The following is an example.* + +| Name | Qualifier | Notes | +|----------------|-----------|-------| +| notifyNewAlarm | M | -- | + +#### W4.5.2 Configuration notifications + +*The following quoted text shall be copied as the only paragraph of this clause.* + +"This clause presents a list of notifications, defined in [x], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [z], shall capture the DN of an instance of a class defined in this specification." + +*The information is provided in a table. The following is an example.* + +| Name | Qualifier | Notes | +|----------------------------|-----------|-------| +| notifyAttributeValueChange | O | -- | +| notifyObjectCreation | O | -- | +| notifyObjectDeletion | O | -- | + +### W4.6 System State Model + +*Some configurations of information are special or complex enough to justify the usage of a state diagram to clarify them. A state diagram in this clause defines permitted states of the system and the transitions between those states. A state is expressed in terms of a combination of attribute values constraints or involvement in relationships of one or more information object classes.* + +## 4.3 Template for Interface IRP IS --- + +### Y1 Scope + +*The following quoted text is relevant for all Interface IRP ISs. It shall be copied as the first two paragraphs of this clause in the Interface IRP IS specification. IRP IS author may add additional paragraph(s) if necessary.* + +“ + +The present document specifies the <> (where <> shall be substituted by the name of the Interface IRP IS concerned such as “Alarm”, “Test”, “Entry Point”) management operations and notifications that can be communicated between an IRP Agent and one or several IRP Managers for telecommunication network management purposes, including management of converged networks. + +This document specifies the semantics and behaviour of operations, notifications and their parameters visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +“ + +### --- Y2 References + +*The following text from the standard 3GPP TS template shall be copied into the Interface IRP IS specification, followed by the TS/TR references used in the specification:* + +“ + +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] ... + +[2] ... + +... + +“ + +### --- Y3 Definitions and abbreviations + +*The following text from the standard 3GPP TS template shall be copied into the NRM IRP IS specification, completed by the definitions and abbreviations used in the specification:* + +“ + +### W3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [x] and the following apply. For terms and definitions not found here, please refer to 3GPP TS . A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [x] and . + +: . + +### W3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [x] 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 [x]. + + + +" + +--- + +### Y4 System overview + +*The following quoted text is relevant for all Interface IRP ISs. It shall be copied as clause 4.1 in the Interface IRP IS specification.* + +" + +### Y4.1 System Context + +The general definition of the System Context for the present IRP is found in 3GPP TS 32.150 [xy] subclause 4.7. + +In addition, the set of related IRP(s) relevant to the present IRP is shown in figure... + + + +" + +--- + +## Y5 Model + +### Y5.1 Imported and associated information entities + +#### Y5.1.1 Imported information entities and local labels + +*This clause identifies a list of information entities (e.g. information object class, interface, attribute) that have been defined in other specifications and that are imported in the present (target) specification. All imported entities shall be treated as if they are defined locally in the target specification. One usage of import is for inheritance purpose.* + +*Each element of this list is a pair (label reference, local label). The label reference contains the name of the original specification where the information entity is defined, the information entity type and its name. The local label contains the name of the information entity that appears in the target specification, and the entity name in the local label shall be kept identical to the name defined in the original specification. The local label can then be used throughout the target specification instead of that which appears in the label reference.* + +*This information is provided in a table. An example of such a table is given here below:* + +| Label reference | Local label | +|----------------------------------------------------|-------------| +| 3GPP TS 32.622 [xy], information object class, Top | Top | + +#### Y5.1.2 Associated information entities and local labels + +*This clause identifies a list of information entities (e.g. information object class, interface, attribute) that have been defined in other specifications and that are associated with the information entities defined in the present (target) specification. For the associated information entity, only its properties (e.g., DN (see 5.2.2 of 32.156 [4]), attribute (see 5.2.1 of 32.156 [4]) of an instance of the associated information entity) used as associated information needs to be supported locally in the target specification.* + +*Each element of this list is a pair (label reference, local label). The label reference contains the name of the original specification where the information entity is defined, the information entity type and its name. The local label contains the name of the information entity that appears in the target specification. The local label can then be used throughout the target specification instead of that which appears in the label reference.* + +*This information is provided in a table. An example of such a table is given here below:* + +| Label reference | Local label | +|---------------------------------------|-------------| +| 3GPP TS 28.705 [12], IOC, HSSFunction | HSSFunction | + +### Y5.2 Class diagram + +#### Y5.2.1 Relationships + +*This first set of diagrams represents all classes defined in this IS with all their relationships and all their attributes, including relationships with imported information entities (if any). These diagrams shall contain class cardinalities (for associations as well as containment relationships) and may also contain role names. These shall be UML compliant class diagrams (see also [4]).* + +*Characteristics (attributes, relationships) of imported information entities need not to be repeated in the diagrams. Allowable classes are specified in [4].* + +*Use this as the first paragraph: "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."* + +#### Y5.2.2 Inheritance + +*This second set of diagrams represents the inheritance hierarchy of all classes defined in this specification. These diagrams do not need to contain the complete inheritance hierarchy but shall at least contain the parent classes of all classes defined in the present document. By default, a class inherits from the class "top".* + +*Characteristics (attributes, relationships) of imported classes need not to be repeated in the diagrams.* + +*NOTE: some inheritance relationships presented in clause Y5.2.2 can be repeated in clause Y5.2.1 to enhance readability.* + +*Use "This subclause depicts the inheritance relationships." as the first paragraph.* + +### Y5.3 Class definitions + +*Each class is defined using the following structure.* + +*Inherited items (attributes etc.) shall not be shown, as they are defined in the parent class(es) and thus valid for the subclass.* + +#### Y5.3.a InformationObjectClassName + +*InformationObjectClassName is the name of the information object class.* + +*The "a" represents a number, starting at 1 and increasing by 1 with each new definition of a class.* + +##### Y5.3.a.1 Definition + +*This clause is written in natural language. The clause refers to the class itself.* + +Optionally, information on traceability back to one or more requirements supported by this class can be defined here, in the following form: + +| Referenced TS | Requirement label | Comment | +|---------------------|-------------------|------------------------| +| 3GPP TS 32.xyz [xy] | REQ-SM-CON-23 | Optional clarification | +| 3GPP TS 32.xyz [xy] | REQ-SM-FUN-11 | Optional clarification | + +##### Y5.3.a.2 Attributes + +This clause presents the list of attributes, which are the manageable properties of the class. Each attribute is characterised by some of the attribute properties (see Table 1 of [4]), i.e. supportQualifier, isReadable, isWritable, isInvariant and isNotifyable. + +The legal values and their semantics for attribute properties are defined in [4]. + +This information is provided in a table. + +An example below indicates + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| eNodeBId | M | M | - | M | M | + +Another example below indicates that the attribute password1 is not readable, is writable, is not an invariant and no notifyAttributeValueChange will be emitted when the attribute value is changed. + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| password1 | O | - | M | - | - | + +Another example below indicates that the attribute password2 and password1 (in example above) has same qualifiers for the shown properties except that of isReadable. In the case of password1, the standard specification determines the qualifier to be M, i.e. it is readable. In the case of password2, the standard specification does not make a determination. The vendor would make the determination if the attribute is readable or not readable. + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| password2 | O | O | M | - | - | + +In case there is one or more attributes related to role (see section 5.2.9 of [4]), the attributes related to role shall be specified at the bottom of the table with a divider "Attribute related to role", as shown in the following example: + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| aTMChannelTerminationPointId | M | M | - | M | M | +| ... | | | | | | +| ... | | | | | | +| Attribute related to role | | | | | | +| theATMPathTerminationPoint | M | M | - | - | M | +| theIubLink | M | M | - | - | M | + +This clause shall state "None." when there is no attribute to define. + +##### Y5.3.a.3 Attribute constraints + +This clause presents constraints for the attributes, and one use is to present the predicates for conditional qualifiers (CM/CO). + +This information is provided in a table. An example of such a table is given here below: + +| Name | Definition | +|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| pci CM write qualifier | Centralized PCI assignment (see TS 32.500, ref [xy] clause 6.1.6) is supported. | +| pciList CM support qualifier | Distributed PCI assignment (see TS 32.500, ref [xy] clause 6.1.6) is supported. | +| partOfSectorPower CM support qualifier | The IOC SectorEquipmentFunction is used. | +| attributeX max value | The value of attributeX shall be within the specified value range but may never be higher than the value of attributeY. | + +*This clause shall state "None." when there is no attribute constraint to define.* + +##### Y5.3.a.4 Notifications + +*This clause, for this class, presents one of the following options:* + +- The class defines (and independent from those inherited) the support of a set of notifications that is identical to that defined in clause Y5.5. In such case, use "The common notifications defined in clause Y5.5 are valid for this class, without exceptions or additions." as the lone sentence of this clause.* +- The class defines (and independent from those inherited) the support of a set of notifications that is a superset of that defined in clause Y5.5. In such case, use "The common notifications defined in clause Y5.5 are valid for this IOC. In addition, the following set of notification is also valid." as the lone paragraph of this clause. Then, define the 'additional' notifications in a table. See clause Y5.5 for the notification table format.* +- The class defines (and independent from those inherited) the support of a set of notifications that is not identical to, nor a superset of, that defined in clause Y5.5. In such case, use "The common notifications defined in clause Y5.5 are not valid for this IOC. The set of notifications defined in the following table is valid." as the lone paragraph of this clause. Specify the set of notifications in a table. See clause Y5.5 for the notification table format.* +- The class does not define (and independent from those inherited) the support of any notification. In such case, use "There is no notification defined." as the lone sentence of this clause.* + +*The notifications identified (i.e. option-a, option-b and option-c above) in this clause are notifications that can be emitted across the If-N, where the "object class" and "object instance" parameters of the notification header (see note 2) of these notifications identifies an instance of the class (or its direct or indirect derived class) defined by the encapsulating clause (i.e. clause Y5.3.a).* + +*The notifications identified (i.e. option-a and option-b above) in this clause, may originate from implementation object(s) whose identifier may or may not be the same as that carried in the notification parameters "object class" and "object instance". Hence the identification of notifications in this clause does not imply nor identify those notifications as being originated from an instance of the class (or its direct or indirect derived class) defined by the encapsulating clause (i.e. clause Y5.3.a).* + +*This clause shall state "This class does not support any notification." (see option-c) when there is no notification defined for this class. (Note that if its parent class has defined some notifications, the implementation of this class is capable of emitting those inherited defined notifications.)* + +*The notification header is defined in the notification IRP Information service TS 32.302 [5].* + +*The qualifier of a notification, specified in Notification Table, indicates if an implementation can generate a notification carrying the DN of the subject class. The qualifier of a notification, specified in an Interface IRP, indicates if an implementation of the Interface IRP can generate such notification in general.* + +*An IRPManager can receive notification-XYZ that carries DN (the "object class" and "object instance") of class-ABC instance if and only if:* + +- The class-ABC Notification Table defines the notification-XYZ and* +- The class-ABC instance implementation supports this notification-XYZ and* +- An Interface IRP defines the notification-XYZ and* + +d) *The Interface IRP implementation supports this notification-XYZ.* + +##### Y5.3.a.5 State diagram + +*This subclause contains state diagrams. A state diagram of an information object class defines permitted states of this information object class and the transitions between those states. A state is expressed in terms of individual attribute values or a combination of attribute values or involvement in relationships of the information object class being defined. This shall be a UML compliant state diagram.* + +*This subclause shall state "None." when there is no State diagram defined.* + +### Y5.4 Attribute definitions + +#### Y5.4.1 Attribute properties + +*It has a lone paragraph "The following table defines the properties of attributes that are specified in the present document. ".* + +*Each information attribute is defined using the following structure.* + +*Inherited attributes shall not be shown, as they are defined in the parent class(es) and thus valid for this class.* + +*An attribute has properties (see Table 1 of [4]). Some properties of an attribute are defined in Y5.3.a.2 (e.g. Support Qualifier). The remaining properties of an attribute (e.g. documentation, default value) are defined here.* + +*The information is provided in a table. In case a) attributes of the same name are specified in more than one class and b) the attributes have different properties, then the attribute names (first column) should be prefixed with the class name followed by a period.* + +*An example is given below:* + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------|------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| xyzId | It identifies ...
allowedValues: ... | type: Integer
multiplicity: ...
isOrdered: ...
isUnique: ...
defaultValue: ...
isNullable: False | +| Abc.state | It indicates ...

allowedValues:
"ON": the state is on;
"OFF": the state is off. | type: <>
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| Zyz.state | It indicates ...

allowedValues:
"HIGH": the state is high;
"MEDIUM": the state is medium;
"LOW": the state is low. | type: <>
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| abc | It defines...

allowedValues: ... | type: ...
multiplicity: ...
isOrdered: ...
isUnique: ...
defaultValue: ...
isNullable: ... | + +*In case there is one or more attributes related to role (see section 5.2.9 of [4]), the attributes related to role shall be specified at the bottom of the table with a divider "Attribute related to role". See example below.* + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------------|-----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| abc | It defines...

allowedValues: ... | type: <>
multiplicity: ...
isOrdered: ...
isUnique: ...
defaultValue: ...
isNullable: ... | +| Attribute related to role | | | +| aEnd | It defines...

allowedValues: Values to be conformant to TS 32.300 [xy] ... | type: DN
multiplicity: ...
isOrdered: ...
isUnique: ...
defaultValue: ...
isNullable: False | + +*This clause shall state "None." if there is no attribute to define.* + +#### Y5.4.2 Constraints + +*This clause indicates whether there are any constraints affecting attributes. Each constraint is defined by a triplet (propertyName, affectedAttributes, propertyDefinition). PropertyDefinitions are expressed in natural language.* + +*An example is given here below:* + +| Name | Affected attribute(s) | Definition | +|----------------------|-----------------------|-------------------------------------------------------------| +| inv_TimerConstraints | ntfTimeTickTimer | The ntfTimeTickTimer is lower than or equal to ntfTimeTick. | + +*This clause shall state "None." if there is no constraint.* + +### Y5.5 Common Notifications + +*This clause presents notifications that can be referred to by any class defined in the specification. This information is provided in tables.* + +*This clause shall state "None." if there are no common notifications.* + +#### Y5.5.1 Alarm notifications + +*The following quoted text shall be copied as the only paragraph of this clause.* + +"This clause presents a list of notifications, defined in [x], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [y], shall capture the DN of an instance of a class defined in this specification." + +*The information is provided in a table. The following is an example.* + +| Name | Qualifier | Notes | +|----------------|-----------|-------| +| notifyNewAlarm | M | -- | + +#### Y5.5.2 Configuration notifications + +*The following quoted text shall be copied as the only paragraph of this clause.* + +"This clause presents a list of notifications, defined in [x], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [z], shall capture the DN of an instance of a class defined in this specification." + +The information is provided in a table. The following is an example. + +| Name | Qualifier | Notes | +|----------------------------|-----------|-------| +| notifyAttributeValueChange | O | -- | +| notifyObjectCreation | O | -- | +| notifyObjectDeletion | O | -- | + +### Y6 Interface Definition + +### Y6.1 Class diagram representing interfaces + +Each interface is defined in one or more UML compliant class diagrams (see also 3GPP TS 32.156 [4]). + +### Y6.2 Generic rules + +The following rules are relevant for all ISs. They shall simply be copied as part of the specification. + +*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.* + +### Y6.b InterfaceName Interface (supportQualifier) + +*InterfaceName is the name of the interface followed by a qualifier indicating whether the interface is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).* + +*"b" represents a number, starting at 3 and increasing by 1 with each new definition of an interface.* + +*Each interface is defined by its name and by a sequence of operations or notifications.* + +*Interfaces related to operations shall be listed before the interfaces related to notifications.* + +*If the interface is related to operation(s), the following Y.b.a "Operation OperationName (supportQualifier)" shall be applied.* + +*If the interface is related to notification(s), the next Y.b.a "Notification NotificationName (supportQualifier)" below shall be applied.* + +#### Y6.b.a Operation OperationName (supportQualifier) + +*OperationName is the name of the operation followed by a qualifier indicating whether the operation is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).* + +*"a" represents a number, starting at 1 and increasing by 1 with each new definition of an operation.* + +##### Y6.b.a.1 Definition + +*This subclause is written in natural language.* + +*Information on traceability back to one or more requirements supported by this operation should also be defined here, in the following form:* + +| Referenced TS | Requirement label | Comment | +|---------------------|-------------------|-------------------------------| +| 3GPP TS 32.xyz [xy] | REQ-SM-CON-23 | Optional clarification | +| 3GPP TS 32.xyz [xy] | REQ-SM-FUN-11 | Optional clarification | + +##### Y6.b.a.2 Input parameters + +*List of input parameters of the operation. Each element is a tuple (Parameter Name, Support Qualifier, Information Type (see [6] and Note 1) and an optional list of Legal Values supported by the parameter, Comment). Legal Values for the Support Qualifier are: Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).* + +*This information is provided in a table. An example of such a table is given here below:* + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|----------------|-------------------|---------------------------------|-------------------------------| +| eventIdList | M | SET OF INTEGER / -- | One or more event identifiers | + +Note 1: Information Type qualifies the parameter of Parameter Name. In the case where the Legal Values can be enumerated, each element is a pair (Legal Value Name, Legal Value Semantics), unless a Legal Value Semantics applies to several values in which case the definition is provided only once. When the Legal Values cannot be enumerated, the list of Legal Values is defined by a single definition. + +##### Y6.b.a.3 Output parameters + +*List of output parameters of the operation. Each element is a tuple (Parameter Name, Support Qualifier, Matching Information / Information Type (see [6]) (Note 1) and an optional list of Legal Values supported by the parameter, Comment). Legal Values for the Support Qualifier are: Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).* + +*This information is provided in a table. An example of such a table is given here below:* + +| Parameter Name | Support Qualifier | Matching Information / Information Type / Legal Values | Comment | +|----------------|-------------------|---------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventTime | M | AlarmInformation.alarmRaisedTime / GeneralizedTime / -- | The parameter carries the
  • alarmRaisedTime in case notificationType carries notifyNewAlarm,
  • alarmChangedTime in case notificationType carries notifyChangedAlarm,
  • alarmClearedTime in case notificationType carries notifyClearedAlarm.
| + +Note 1: Information Type qualifies the parameter of Parameter Name. In the case where the Legal Values can be enumerated, each element is a pair (Legal Value Name, Legal Value Semantics), unless a Legal Value Semantics applies to several values in which case the definition is provided only once. When the Legal Values cannot be enumerated, the list of Legal Values is defined by a single definition. + +*This table shall also include a special parameter 'status' to indicate the completion status of the operation (success, partial success, failure reason etc.).* + +##### Y6.b.a.4 Pre-condition + +A pre-condition is a collection of assertions joined by AND, OR, and NOT logical operators. The pre-condition must be held to be true before the operation is invoked. An example is given here below: + +``` +notificationCategoriesNotAllSubscribed OR + notificationCategoriesParameterAbsentAndNotAllSubscribed +``` + +Each assertion is defined by a pair (propertyName, propertyDefinition). All assertions constituting the pre-condition are provided in a table. An example of such a table is given here below: + +| Assertion Name | Definition | +|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationCategoriesNotAllSubscribed | At least one notificationCategory identified in the notificationCategories input parameter is supported by IRPAGENT and is not a member of the ntfNotificationCategorySet attribute of an NtfSubscription which is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter. | +| notificationCategoriesParameterAbsentAndNotAllSubscribed | The notificationCategories input parameter is absent and at least one notificationCategory supported by IRPAGENT is not a member of the ntfNotificationCategorySet attribute of an ntfSubscription which is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter. | + +##### Y6.b.a.5 Post-condition + +A post-condition is a collection of assertions joined by AND, OR, and NOT logical operators. The post-condition must be held to be true after the completion of the operation. When nothing is said in a post-condition regarding an information entity, the assumption is that this information entity has not changed compared to what is stated in the pre-condition. An example is given here below: + +``` +subscriptionDeleted OR allSubscriptionDeleted +``` + +Each assertion is defined by a pair (propertyName, propertyDefinition). All assertions constituting the post-condition are provided in a table. An example of such a table is given here below: + +| Assertion Name | Definition | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscriptionDeleted | The ntfSubscription identified by subscriptionId input parameter is no more involved in a subscription relationship with the ntfSubscriber identified by the managerReference input parameter and has been deleted. If this ntfSubscriber has no more ntfSubscription, it is deleted as well. | +| allSubscriptionDeleted | In the case subscriptionId input parameter was absent, the ntfSubscriber identified by the managerReference input parameter is no more involved in any subscription relationship and is deleted, the corresponding ntfSubscription have been deleted as well. | + +##### Y6.b.a.6 Exceptions + +List of exceptions that can be raised by the operation. Each element is a tuple (exceptionName, condition, ReturnedInformation, exitState). + +###### Y6.b.a.6.c exceptionName + +ExceptionName is the name of an exception. + +"c" represents a number, starting at 1 and increasing by 1 with each new definition of an exception. + +This information is provided in a table. An example of such a table is given here below: + +| Exception Name | Definition | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ope_failed_existing_subscription | Condition: (notificationCategoriesNotAllSubscribed OR notificationCategoriesParameterAbsentAndNotAllSubscribed) not verified.
Returned information: output parameter status is set to OperationFailedExistingSubscription.
Exit state: Entry State. | + +##### Y6.b.a.7 Constraints + +*This subclause presents constraints for the operation or its parameters.* + +*This subclause does not need to be present when there are no constraints to define.* + +#### Y6.b.a Notification NotificationName (supportQualifier) + +*NotificationName is the name of the notification followed by a qualifier indicating whether the notification is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO) or SS-Conditional (C).* + +*"a" represents a number, starting at 1 and increasing by 1 with each new definition of a notification.* + +##### Y6.b.a.1 Definition + +*This subclause is written in natural language.* + +*Information on traceability back to one or more requirements supported by this notification should also be defined here, in the following form:* + +| Referenced TS | Requirement label | Comment | +|---------------------|-------------------|-------------------------------| +| 3GPP TS 32.xyz [xy] | REQ-SM-CON-23 | Optional clarification | +| 3GPP TS 32.xyz [xy] | REQ-SM-FUN-11 | Optional clarification | + +##### Y6.b.a.2 Input parameters + +*List of input parameters of the notification. Each element is a tuple (Parameter Name, Qualifiers, Matching Information / Information Type (see [6]) (Note 1) and an optional list of Legal Values supported by the parameter, Comment).* + +*The column "Qualifiers" contains the two qualifiers, Support Qualifier and Filtering Qualifier, separated by a comma. The Support Qualifier indicates whether the attribute is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C). The Filtering Qualifier indicates whether the parameter of the notification can be filtered or not. Values are Yes (Y) or No (N).* + +*This information is provided in a table. An example of such a table is given here below:* + +| Parameter Name | Qualifiers | Matching Information / Information Type / Legal Values | Comment | +|------------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| managerReference | M,Y | ntfSubscriber.ntfManagerReference / STRING / -- | It specifies the reference of IRPManager to which notifications shall be sent. | +| alarmType | M,Y | AlarmInformation.eventType / ENUMERATED /
"Communications Alarm": a communication error alarm.
"Processing Error Alarm": a processing error alarm.
"Environmental Alarm": an environmental violation alarm.
"Quality Of Service Alarm": a quality of service violation alarm.
"Equipment Alarm": an alarm related to equipment malfunction. | | + +Note 1: Information Type qualifies the parameter of Parameter Name. In the case where the Legal Values can be enumerated, each element is a pair (Legal Value Name, Legal Value Semantics), unless a Legal Value Semantics applies to several values in which case the definition is provided only once. When the Legal Values cannot be enumerated, the list of Legal Values is defined by a single definition. + +##### Y6.b.a.3 Triggering event + +*The triggering event for the notification to be sent is the transition from the information state defined by the "from state" subclause to the information state defined by the "to state" subclause.* + +###### Y6.b.a.3.1 From state + +This subclause is a collection of assertions joined by AND, OR, and NOT logical operators. An example is given here below: + +`alarmMatched AND alarmInformationNotCleared` + +Each assertion is defined by a pair (propertyName, propertyDefinition). All assertions constituting the state "from state" are provided in a table. An example of such a table is given here below: + +| Assertion Name | Definition | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| alarmMatched | The matching-criteria-attributes of the newly generated network alarm has values that are identical (matches) with ones in one AlarmInformation in AlarmList.. | +| alarmInformationNotCleared | The perceivedSeverity of the newly generated network alarm is not Cleared. | + +###### Y6.b.a.3.2 To state + +This subclause is a collection of assertions joined by AND, OR and NOT logical operators. When nothing is said in a to-state regarding an information entity, the assumption is that this information entity has not changed compared to what is stated in the from-state. An example is given here below: + +`resetAcknowledgementInformation AND perceivedSeverityUpdated` + +Each assertion is defined by a pair (propertyName, propertyDefinition). All assertions constituting the state "to state" are provided in a table. An example of such a table is given here below: + +| Assertion Name | Definition | +|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| resetAcknowledgementInformation | The matched AlarmInformation identified in inv_alarmMatched in pre-condition has been updated according to the following rule:
ackTime, ackUserId and ackSystemId are updated to contain no information;
ackState is updated to "unacknowledged". | +| perceivedSeverityUpdated | The perceivedSeverity attribute of matched AlarmInformation identified in inv_alarmMatched in pre-condition has been updated. | + +##### Y6.b.a.4 Constraints + +This subclause presents constraints for the notification or its parameters. + +This subclause does not need to be present when there are no constraints to define. + +### Y6.c Scenario + +This subclause contains one or more sequence diagrams, each describing a possible scenario. These shall be UML compliant sequence diagrams. This is an optional subclause. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|-----------------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2013-06 | SA#60 | SP-130304 | 001 | 1 | Correct the description of the attribute definition table | 11.0.0 | 11.1.0 | +| 2013-09 | SA#61 | SP-130433 | 002 | 1 | Correction of ambiguous statements | 11.1.0 | 11.2.0 | +| 2013-12 | SA#62 | SP-130614 | 003 | 1 | Move instruction to the correct subclause | 11.2.0 | 11.3.0 | +| 2014-06 | SA#64 | SP-140359 | 004 | - | remove the feature support statements | 11.3.0 | 11.4.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | 11.4.0 | 12.0.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-12 | SA#74 | SP-160855 | 0005 | - | B | Include Interface IRP template | 14.0.0 | +| 2017-04 | | | | | | Various editorial fixes (MCC) | 14.0.1 | +| 2018-06 | SA#80 | SP-180423 | 0009 | 1 | A | Align terminology | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2018-07 | | | | | | Correccion in history table (MCC) | 15.0.1 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | - | - | - | - | - | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-04 | - | - | - | - | - | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/32_series/32158/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-18/32_series/32158/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eb76127dc6ddafecab6389473b8c8cd2e3cf6f67 --- /dev/null +++ b/marked/Rel-18/32_series/32158/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6afa879af2d65e90d502b2778066a9c4bb14626ea669849c965448d61d8d640 +size 17425 diff --git a/marked/Rel-18/32_series/32158/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-18/32_series/32158/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fb0c25da2c994afb47a96bade6f36470e569e3b2 --- /dev/null +++ b/marked/Rel-18/32_series/32158/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c065707c4bdadee8c19c6818760348177dc70af1ad542f83bc943fe0a27ee798 +size 22498 diff --git a/marked/Rel-18/32_series/32158/29f586959675cafdf81cf934954908eb_img.jpg b/marked/Rel-18/32_series/32158/29f586959675cafdf81cf934954908eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4c3d604d72567e80a932a6b810963694e02f9b15 --- /dev/null +++ b/marked/Rel-18/32_series/32158/29f586959675cafdf81cf934954908eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:365ebc4a0fbe3c6b2f3f9d12b484aef9aa46eddf05bedcfec46d0f9a31eb40f2 +size 15328 diff --git a/marked/Rel-18/32_series/32158/51db757d054ce1ce83c436a3578b56ca_img.jpg b/marked/Rel-18/32_series/32158/51db757d054ce1ce83c436a3578b56ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e8a8fc161b92fbbe73cdae8c79e15f3c00da6b61 --- /dev/null +++ b/marked/Rel-18/32_series/32158/51db757d054ce1ce83c436a3578b56ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e3ae373fb642e04fb5bdf7dd67608cc0e5a121ef3330a4452d2718f4e77b422 +size 23014 diff --git a/marked/Rel-18/32_series/32158/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32158/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a27a1d3502062ae58652228145793c900ada790 --- /dev/null +++ b/marked/Rel-18/32_series/32158/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2937407affd387613677da8bb30cd5cb61803b5b76110e4205688e9fff9708c1 +size 5714 diff --git a/marked/Rel-18/32_series/32158/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg b/marked/Rel-18/32_series/32158/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6a9059d30b930fc36768495cb29f99fc8980fcd2 --- /dev/null +++ b/marked/Rel-18/32_series/32158/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:08a284912cb976cb5d9d1874e2e2c24471fc5b4bf03dec2a4428f978500a6cc2 +size 21764 diff --git a/marked/Rel-18/32_series/32158/86d30a7d5a9cd4ee5456b5962ae3420a_img.jpg b/marked/Rel-18/32_series/32158/86d30a7d5a9cd4ee5456b5962ae3420a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2b94b0d44c16f0e9450922f18f563a3997cd4b9e --- /dev/null +++ b/marked/Rel-18/32_series/32158/86d30a7d5a9cd4ee5456b5962ae3420a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3550688c183e57c160d77f38508d811b0c4373cd0f965987bcf3ef7243385f4 +size 22936 diff --git a/marked/Rel-18/32_series/32158/898fb89a50d9ec1dfb4e425c816976a7_img.jpg b/marked/Rel-18/32_series/32158/898fb89a50d9ec1dfb4e425c816976a7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd165672ecf49f9c6c5ce3defdcb240a54372546 --- /dev/null +++ b/marked/Rel-18/32_series/32158/898fb89a50d9ec1dfb4e425c816976a7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:184ef2cf40290d8ebd675ecf97928e30566ca5bc7b1f40575ca729466927aa95 +size 19546 diff --git a/marked/Rel-18/32_series/32158/a7c51c18111139f9aca2805114108565_img.jpg b/marked/Rel-18/32_series/32158/a7c51c18111139f9aca2805114108565_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c4d3571f2826eab312bfcfec8dc2b6686a17ba25 --- /dev/null +++ b/marked/Rel-18/32_series/32158/a7c51c18111139f9aca2805114108565_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b896080ddae7220153c73ec68dedd570a002863ad6c1083f45ba21d3091f4dcc +size 21853 diff --git a/marked/Rel-18/32_series/32158/c036e2540a94b31357ceb0002f0cacab_img.jpg b/marked/Rel-18/32_series/32158/c036e2540a94b31357ceb0002f0cacab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dae26585ba4da466419ff4b67e02d353adb0ea1a --- /dev/null +++ b/marked/Rel-18/32_series/32158/c036e2540a94b31357ceb0002f0cacab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6a3947e1b4b2764df9edb71eea78d3dce80aef9d2f9170506f79d3b8a61e32a4 +size 21983 diff --git a/marked/Rel-18/32_series/32158/dc23d430e878eb71b8cd589984113940_img.jpg b/marked/Rel-18/32_series/32158/dc23d430e878eb71b8cd589984113940_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8bf9f4c7f1d602cf46a2eea586759057fecea77d --- /dev/null +++ b/marked/Rel-18/32_series/32158/dc23d430e878eb71b8cd589984113940_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:adbc65157ad38ee5bdb23d00246b559c0c938778c08be58aec45f63b8123a43f +size 17478 diff --git a/marked/Rel-18/32_series/32158/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg b/marked/Rel-18/32_series/32158/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c4bed33a7e47734464397423c12bc697c55a0a8 --- /dev/null +++ b/marked/Rel-18/32_series/32158/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:771d6dd3c0beff881de2b166c23744006522a2bd4befd74b350b3b819f102a30 +size 18829 diff --git a/marked/Rel-18/32_series/32158/raw.md b/marked/Rel-18/32_series/32158/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..baf13c91bb0871f04a2c0c1387ba5f937506bf0c --- /dev/null +++ b/marked/Rel-18/32_series/32158/raw.md @@ -0,0 +1,5425 @@ + + +# 3GPP TS 32.158 V18.4.0 (2025-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Management and orchestration; Design rules for REpresentational State Transfer (REST) Solution Sets (SS) (Release 18)** --- + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo features a large, bold black '5G' with a green signal wave icon above the 'G'. To the right of the 'G' is the word 'ADVANCED' in a smaller, black, sans-serif font. + +5G Advanced logo + +## --- **Keywords** + +--- + +REST, HTTP, API + +## **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. + +© 2025, 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 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 General rules ..... | 7 | +| 4.1 Information models and resources ..... | 7 | +| 4.1.1 Information models ..... | 7 | +| 4.1.2 Resources..... | 8 | +| 4.1.3 Resource archetypes ..... | 8 | +| 4.1.4 Mapping of information models to resources..... | 8 | +| 4.1.5 Usage of information models ..... | 8 | +| 4.2 Managed object naming and resource identification..... | 9 | +| 4.2.1 Managed object naming ..... | 9 | +| 4.2.1.0 Distinguished Name (DN) ..... | 9 | +| 4.2.1.1 Global and local namespaces ..... | 9 | +| 4.2.2 Resource identification..... | 9 | +| 4.2.3 Mapping of DNs to URIIs ..... | 9 | +| 4.2.4 Canonical URI..... | 10 | +| 4.3 Message content formats..... | 11 | +| 4.3.1 Media types ..... | 11 | +| 4.3.2 Response content format negotiation ..... | 11 | +| 4.4 URI structure ..... | 11 | +| 4.4.1 Introduction ..... | 11 | +| 4.4.2 URI structure for resources representing managed object instances ..... | 11 | +| 4.4.3 URI structure for resources not representing managed object instances..... | 13 | +| 4.4.4 Resource "../{MnSName}/{MnSVersion}" ..... | 13 | +| 4.5 Response status codes ..... | 14 | +| 5 Basic design patterns..... | 14 | +| 5.1 Design pattern for creating a resource..... | 14 | +| 5.1.1 Creating a resource with identifier creation by the MnS Producer ..... | 14 | +| 5.1.2 Creating a resource with identifier creation by the MnS Consumer ..... | 15 | +| 5.2 Design pattern for reading a resource ..... | 16 | +| 5.3 Design pattern for updating a resource ..... | 16 | +| 5.4 Design pattern for deleting a resource..... | 17 | +| 5.5 Design pattern for subscribe/notify ..... | 18 | +| 5.5.1 Concept..... | 18 | +| 5.5.2 Subscription creation ..... | 18 | +| 5.5.3 Subscription deletion ..... | 18 | +| 5.5.4 Notification emission..... | 19 | +| 5.5.5 Subscription retrieval..... | 19 | +| 6 Advanced design patterns ..... | 20 | +| 6.1 Design pattern for scoping and filtering..... | 20 | +| 6.1.1 Introduction ..... | 20 | +| 6.1.2 Query parameters for scoping..... | 20 | +| 6.1.3 Query parameters for filtering ..... | 20 | +| 6.1.4 Construction rules for the response message body..... | 21 | +| 6.2 Design patterns for attribute and attribute field selection ..... | 22 | +| 6.2.1 Introduction ..... | 22 | +| 6.2.2 Query parameters for attribute and attribute field selection..... | 22 | +| 6.2.3 Construction rules for the response message body..... | 22 | +| 6.3 Design pattern for partially updating a resource ..... | 22 | + +| | | | +|-------------------------------|-----------------------------------------------------------------------------------------------------------|-----------| +| 6.3.1 | Introduction ..... | 22 | +| 6.3.2 | JSON Merge Patch ..... | 23 | +| 6.3.3 | JSON Patch..... | 24 | +| 6.4 | Design patterns for patching multiple resources ..... | 28 | +| 6.4.1 | Introduction ..... | 28 | +| 6.4.2 | 3GPP JSON Merge Patch ..... | 28 | +| 6.4.3 | 3GPP JSON Patch ..... | 28 | +| 6.5 | Design pattern for large queries ..... | 31 | +| 6.6 | Design pattern for error responses ..... | 31 | +| 6.6.1 | Introduction ..... | 31 | +| 6.6.2 | HTTP error codes ..... | 32 | +| 6.6.3 | Error response body..... | 33 | +| 6.6.3.1 | Overview..... | 33 | +| 6.6.3.2 | Error response format for GET requests..... | 34 | +| 6.6.3.3 | Error response format for PUT, POST, DELETE, JSON Merge Patch and 3GPP JSON Merge
Patch requests ..... | 34 | +| 6.6.3.4 | Error response format for JSON Patch and 3GPP JSON Patch requests..... | 35 | +| 6.6.4 | The "type" property ..... | 35 | +| 6.6.5 | The "reason" property..... | 36 | +| 6.6.5.1 | Overview..... | 36 | +| 6.6.5.2 | Error reasons for GET..... | 37 | +| 6.6.5.3 | Error reasons for attribute manipulations ..... | 38 | +| 6.6.5.3.1 | JSON Patch and 3GPP JSON Patch..... | 38 | +| 6.6.5.3.2 | JSON Merge Patch, 3GPP JSON Merge Patch and PUT ..... | 40 | +| 6.6.5.4 | Error reasons for object manipulations..... | 41 | +| 6.6.6 | Error reasons for application layer errors..... | 45 | +| 6.6.7 | Security considerations..... | 46 | +| 6.7 | Design pattern for conditional data node selection ..... | 46 | +| 7 | Resource representation formats..... | 46 | +| 7.1 | Introduction ..... | 46 | +| 7.2 | Top-level object..... | 46 | +| 7.3 | Data objects ..... | 47 | +| 7.4 | Data arrays..... | 47 | +| 7.5 | Error objects ..... | 47 | +| 7.6 | Resource objects..... | 48 | +| 7.7 | Resource objects carried in data objects and arrays ..... | 48 | +| 8 | REST SS specification template ..... | 49 | +| Annex A (informative): | Examples ..... | 54 | +| A.1 | Example data model..... | 54 | +| A.2 | Retrieval of resources..... | 59 | +| A.2.1 | Retrieval of a single complete resource with HTTP GET ..... | 59 | +| A.2.2 | Attribute and attribute field selection on a single resource..... | 60 | +| A.2.3 | Retrieval of multiple complete resources using scoping and filtering ..... | 61 | +| A.2.4 | Large queries ..... | 71 | +| A.3 | Creation of resources ..... | 71 | +| A.3.1 | Creation of a resource with HTTP PUT..... | 71 | +| A.3.2 | Creation of a resource with HTTP POST..... | 72 | +| A.3.3 | Creation of multiple resources with 3GPP JSON Merge Patch ..... | 73 | +| A.3.4 | Creation of multiple resources with 3GPP JSON Patch ..... | 75 | +| A.4 | Deletion of resources ..... | 77 | +| A.4.1 | Deletion of a resource with HTTP DELETE ..... | 77 | +| A.4.2 | Deletion of multiple resources with HTTP DELETE ..... | 77 | +| A.4.3 | Deletion of multiple resources with 3GPP JSON Merge Patch ..... | 77 | +| A.4.4 | Deletion of multiple resources with 3GPP JSON Patch ..... | 78 | +| A.5 | Complete update of a resource..... | 78 | +| A.6 | Partial update of a resource..... | 79 | + +| | | | +|-------------------------------|------------------------------------------------------------------|-----------| +| A.6.1 | Partial update of a resource with JSON Merge Patch ..... | 79 | +| A.6.2 | Partial update of a resource with 3GPP JSON Merge Patch ..... | 80 | +| A.6.3 | Partial update of a resource with JSON Patch ..... | 80 | +| A.6.4 | Partial update of a resource with 3GPP JSON Patch ..... | 82 | +| A.7 | Manipulating multiple resources ..... | 83 | +| A.7.1 | Manipulating multiple resources with 3GPP JSON Merge Patch ..... | 83 | +| A.7.2 | Manipulating multiple resources with 3GPP JSON PATCH ..... | 84 | +| A.8 | Partitioning a data model ..... | 86 | +| Annex B (informative): | Change history ..... | 87 | + +# 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 design rules for REpresentational State Transfer (REST) Solution Sets (SS). These rules are applied when specifying REST Solution Sets. + +# 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 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [3] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [4] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [5] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [6] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [7] draft-bhutton-json-schema-01 (June 2022): "JSON Schema: A Media Type for Describing JSON Documents". + +Note: The above document is an individual draft from IETF. It cannot be formally referenced until it is published as an RFC. It is available from the following link: + +. + +- [8] draft-bhutton-json-schema-validation-01 (June 2022): "JSON Schema Validation: A Vocabulary for Structural Validation of JSON". + +Note: The above document is an individual draft from IETF. It cannot be formally referenced until it is published as an RFC. It is available from the following link: + +. + +- [9] draft-handrews-json-schema-hyperschema-02 (September 2019): "JSON Hyper-Schema: A Vocabulary for Hypermedia Annotation of JSON". + +Note: The above document is an individual draft from IETF. It cannot be formally referenced until it is published as an RFC. It is available from the following link: + +. + +- [10] OpenAPI Specification () + +- [11] IETF RFC 5789: "PATCH Method for HTTP". + +- [12] IETF RFC 7396: "JSON Merge Patch". + +- [13] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". + +- [14] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". + +- [15] XML Path Language (XPath) Version 1.0, W3C Recommendation 16 November 1999 () + +- [16] 3GPP TS 32.160: "Management and orchestration; Management service template". +- [17] IETF RFC 4918: "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)" +- [18] IETF RFC 6585: "Additional HTTP Status Codes" +- [19] IETF RFC 7807: "Problem Details for HTTP APIs" +- [20] IETF RFC 7725: "An HTTP Status Code to Report Legal Obstacles" +- [21] 3GPP TS 32.161: "JSON expressions (Jex)" + +# --- 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]. + +## 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]. + +| | | +|------|----------------------------------| +| CRUD | Create, Retrieve, Update, Delete | +| DC | Domain Component | +| DN | Distinguished Name | +| DNS | Domain Name Service | +| FQDN | Fully Qualified Domain Name | +| HTTP | Hypertext Transfer Protocol | +| JSON | JavaScript Object Notation | +| LDN | Local Distinguished Name | +| MnS | Management Service | +| REST | REpresentational State Transfer | +| RPC | Remote Procedure Call | +| TCP | Transmission Control Protocol | +| URI | Uniform Resource Identifier | + +# --- 4 General rules + +## 4.1 Information models and resources + +### 4.1.1 Information models + +An information model is a representation of a system. Typical models do not reflect all facets of the system, but only certain aspects required to solve the management problem the model is designed for. 3GPP follows an object-oriented modelling approach. Models are built from managed object classes. Each object class contains information elements called attributes. Relationships between classes represent the logical connections. Models are specified formally with class diagrams produced using the Unified Modelling Language (UML). + +The instantiation of a managed object class is called managed object instance, or concisely just managed object or object. All managed object instances together with the relationships between them constitute an object tree. An object tree is also called containment tree. + +### 4.1.2 Resources + +HTTP uses a different terminology based on the notion of resources, as defined in clause 2 of RFC 7231 [2]. Each resource is represented by one or more resource representations as defined in clause 3 of RFC 7231 [2]. Valid resource representations are e.g. XML instance documents or JSON instance documents. + +Besides this primary resource, RFC 3986 [4], clause 3.5 introduces the concept of secondary resources. Secondary resources are specific portions or subsets of primary resources, that are identifiable. + +### 4.1.3 Resource archetypes + +Resources can be classified according to their structure and behaviour into resource archetypes. This helps specifying clear and understandable interfaces. The following three archetypes are defined: + +- **Document resource:** This is the standard resource containing data in form of name value pairs and links to related resources. This kind of resource typically represents a real-world object or a logical concept. +- **Collection resource:** A collection resource is grouping resources of the same kind. The resources below the collection resource are called items of the collection. An item of a collection is normally a document resource. Collection resources typically contain links to the items of the collection and information about the collection like the total number of items in the collection. Collection resources can be further distinguished into server-managed and client-managed resources. Collection resources are also known as container resources. +- **Operation resource:** Operation resources represent executable functions. They may have input and output parameters. Operation resources allow some sort of fall back to an RPC style design in case application specific actions cannot be mapped easily to CRUD style operations. + +### 4.1.4 Mapping of information models to resources + +RESTful SS shall be specified in a way that managed object instances are described by (primary) document resources. Collection resources have no equivalent in an information model unless some dedicated collection class is introduced. + +Attributes are mapped to secondary resources. + +### 4.1.5 Usage of information models + +Information models are used for two purposes when specifying interfaces to observe and act upon information models: + +- They provide a means to identify information in request messages. +- They provide a format to transfer information in request and response messages. +- They provide constraints on the structure of information on the MnS Producer. +- They provide constraints on the possibilities to update information on the MnS Producer. + +Identification of information is necessary when retrieving information from a MnS Producer; the MnS Consumer needs to be able to specify in his retrieve request the information the MnS Producer shall return. But also when information needs to be updated or deleted the MnS Consumer needs to identify the information to be updated or deleted in his request. When information is added, the location of the new information is specified relative to the location of existing information. + +Request and response message bodies carrying (some parts of) the information model are also constructed based on the information model supported by the MnS Producer. The message format is either identical to the information model format or identical to some transformation of the information model format. + +## 4.2 Managed object naming and resource identification + +### 4.2.1 Managed object naming + +#### 4.2.1.0 Distinguished Name (DN) + +The Distinguished Name (DN) is used in 3GPP to uniquely identify a managed object instance within a specific name space. The DN is a comma (",") separated list of Relative Distinguished Names (RDNs). Each managed object instance has an associated RDN. The sequence of RDNs is governed by name containment relationships in the UML class diagram describing the modelled network. The RDN consists of a naming attribute name separated by an equal sign ("=") from the naming attribute value. The naming attribute name is equal to the class name of the MOI. + +In addition to the RDNs associated to a managed object instance the DN may have as leftmost RDN whose naming attribute name is "DC" (Domain Component) and whose value is a domain name. A DN with DC is globally unique. + +The DN concept is described in detail in TS 32.300 [3]. The following example DN has a DC. + +DN = "DC=operatorA.com, SubNetwork=south, ManagedElement=a, ENBFunction=1, Cell=1" + +#### 4.2.1.1 Global and local namespaces + +A DN in the global name space is globally unique and starts with the RDN of the global root. A DN in a local name space starts with the RDN of the local root and is unique only within this name space. A DN in a local namespace is also referred to as Local Distinguished Name (LDN). The DN of the local root relative to the global root is called DN prefix. The concatenation of DN prefix and LDN is equal to the globally unique DN of a managed object. + +The local root is typically the root of the network resource model representing the managed network. + +### 4.2.2 Resource identification + +HTTP uses a subset of the generic Uniform Resource Identifier (URI) scheme (RFC 3986 [4]) defined in RFC 7230 [5] for target resource identification. + +`http-URI = "http:" "//" authority path-abempty [ "?" query ] [ "#" fragment ]` + +The path component is an absolute path (one that starts with a single slash character) or empty. + +The origin server is identified by the authority component, which includes a host identifier and an optional TCP port. The hierarchical path component and optional query component serve as an identifier for a potential target resource within that origin server's name space. The optional fragment component allows for indirect identification of a secondary resource. The host identifier is either an IP address or an indirect identifier such as a FQDN to be resolved with DNS. + +URIs are used by HTTP for routing and addressing of target resources. + +### 4.2.3 Mapping of DNs to URIs + +URIs are globally unique. For this reason only a globally unique DN with DC is mappable into a URI. The mapping rules are as follow: + +- The DN prefix is mapped semantically to the authority component of the URI. The syntax of the DN prefix is modified to match the syntax of the authority component. +- The LDN is mapped semantically to the path component of the URI. The syntax of the LDN is modified to match the syntax of the path component. + +When mapping a LDN the equal sign "=" shall be used as delineator between the naming attribute name and naming attribute value when constructing a RDN. + +`URI-RDN = {namingAttributeName} "=" {namingAttributeValue}` + +The URI-LDN is the concatenation of URI-RDNs separated by a slash "/". + +URI-LDN = \*( "/" RDN ) + +For example, the LDN + +LDN = "SubNetwork=south,ManagedElement=a,ENBFunction=1,Cell=1" +maps to + +URI-LDN = "/SubNetwork=south/ManagedElement=a/ENBFunction=1/Cell=1" + +and the LDN + +LDN = "ManagedElement=a,ENBFunction=1,Cell=1" +to + +URI-LDN = "/ManagedElement=a/ENBFunction=1/Cell=1" + +When constructing the authority part from the DN prefix, it shall be reformatted according to the name conventions applying to FQDNs. For example, the DN prefix + +DN-prefix = "DC=operatorA.com" + +maps to + +URI-DN-prefix = "operatorA.com" + +and the DN prefix + +DN-prefix = "DC=operatorA.com,SubNetwork=south" + +to + +URI-DN-prefix = "south.subNetwork.operatorA.com" + +The complete URIs for the examples are + +http://operatorA.com/SubNetwork=south/ManagedElement=a/ENBFunction=1/Cell=1 +http://south.subNetwork.operatorA.com/ManagedElement=a/ENBFunction=1/cell=1 + +The constructed URI-DN-prefix is a FQDN that can be registered into a name resolution service such as DNS. The sole presence of a constructed FQDN does not mean it can be resolved to an IP address and there is a server listening at that address. + +Using the mapping rule, a DN is mapped predictably into the URI authority component and path component. + +The character set allowed in DNs is much bigger than the character set allowed in the path component and authority component of a URI. Care needs to be taken when selecting the naming attribute names and values that the mapping from a DN to a URI does not become impossible as a consequence of not mappable characters. + +When no registered name can be used, the IP address shall be specified directly in the host component, for example: + +http://168.212.226.204/SubNetwork=south/.../Cell=1 + +This might be required in multiple situations. For example, when a DN prefix is used but the corresponding URI-DN-prefix cannot be resolved, the MnS Consumer needs to specify an IP address in the target URI of HTTP request messages. The same is true when no DN prefix is used at all. Another example is when no DN prefix is configured into MnS Producers and the MnS Producer wants to report events, that occurred related to resources, using notifications sent to MnS Consumers. The MnS Producer has no other option than to put its own IP address into the host component of the URI identifying the resource where the event occurred. + +### 4.2.4 Canonical URI + +The URI defined in clause 4.2.3 is called canonical URI. It is the main or official URI of a resource. It shall be used whenever the resource as such shall be identified. The URI for sending HTTP requests to a resource may be different as described in clause 4.4. Special kinds of requests may have all their own URI. Therefore, a resource has typically one + +canonical URI and one or more other URIs. The canonical URI may be looked at as a protocol specific version of the protocol neutral DN. + +A canonical URI may or may not yield further information if dereferenced. + +An example usage of a canonical URI is in event notifications such as alarm notifications for identifying the resource where the event occurred. + +## 4.3 Message content formats + +### 4.3.1 Media types + +The format of HTTP request and response message content is indicated with media types consisting of a type, a subtype and optional parameters, as defined in clause 3.1.1.1 of RFC 7231 [2]. The "Content-Type" header field of a message contains the media type of the message content (clause 3.1.1.5 of RFC 7231 [2]). + +If not otherwise stated, the media type of request and response message bodies in the REST SS is + +- application/json (RFC 7159 [6]). + +Exceptions are when JSON patch documents are contained in request bodies. They are identified with the media types + +- application/merge-patch+json (RFC 7396 [12], and clause 6.3.2 of the present document), +- application/json-patch+json (RFC 6902 [13], and clause 6.3.3 of the present document). + +Furthermore, this specification defines four new formats. Their media types are + +- application/vnd.3gpp.merge-patch+json (clause 6.4.2 of the present document), +- application/vnd.3gpp.json-patch+json (clause 6.4.3 of the present document), +- application/vnd.3gpp.object-tree-hierarchical+json (clause 6.1.4 of the present document), +- application/vnd.3gpp.object-tree-flat+json (clause 6.1.4 of the present document). + +JSON documents shall conform to JSON Schema ([7], [8], [9]). + +### 4.3.2 Response content format negotiation + +The MnS Consumer shall engage in proactive content negotiation as defined in clause 3.4.1 of RFC 7231 [2] by including the "Accept" request header field in HTTP requests that expect a message body in the response. The "Accept" header field indicates to the MnS Producer the media types acceptable to the MnS Consumer. + +If the MnS Producer cannot provide any of the acceptable resource representations, it shall respond either with a "406 Not Acceptable" error code or provide a representation for the resource that is not specified in the "Accept" header field. + +## 4.4 URI structure + +### 4.4.1 Introduction + +MnS producers can be divided into two categories. The first category exposes MnS(s) to manipulate resources representing managed object instances. In this case the URI structure is governed by the mapping rules defined in clause 4.2.3. The second category exposes MnS(s) to manipulate resources not representing managed object instances. In this case the DN concept is not relevant. The URI structure for both categories is different. + +### 4.4.2 URI structure for resources representing managed object instances + +URIs identifying resources representing managed object instances shall follow, when being used as a target URI in HTTP requests, the structure given by + +{scheme} : // {URI-DN-prefix} / {root} / {MnSName} / {MnSVersion} / {URI-LDN} + +with: + +| | | +|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| {scheme} | Scheme component "http" or "https" | +| {URI-DN-prefix} | Authority component (host identifier and optional TCP port), the host name is constructed from the DN prefix as defined in clause 4.2.3. | +| {root} | Part of the path component, allows specifying one or more optional path segments for structuring the resource hierarchy on a HTTP server. The DN or parts thereof shall not be mapped to this path component. | +| {MnSName} | Part of the path component, allows specifying an optional MnS name in a single path segment. | +| {MnSVersion} | Part of the path component, allows specifying an optional MnS version in a single path segment. | +| {URI-LDN} | Part of the path component, constructed from the LDN as defined in clause 4.2.3, containing zero, one or more path segments. | + +As seen above, to construct the URI from a DN, it is necessary to map the "DNPrefixPlusRDNSeparator" as defined in clause 7.3 of TS 32.300 [3], the "LocalDN" as defined in clause 7.3 of TS 32.300 [3], and to add the additional optional path segments "{root}/{MnSName}/{MnSVersion}". + +To allow for a predictive mapping from an URI to the original DN it is necessary to specify "{MnSName}/{MnSVersion}" in such a way that the beginning of the "LocalDN" can be unambiguously identified. + +Note it may be required when specifying a MnS to clearly identify the last RDN of "{URI-LDN}" and to use the following instead of "{URI-LDN}" + +{URI-LDN-first-part} / {RDN} + +or + +{URI-LDN-first-part} / {className}={id}. + +For the sake of brevity, "MnSRoot" is introduced that includes the "{scheme}" part, the colon (":"), the two slash characters ("//"), the "{authority}" part, a single slash character ("/") and the "{root}" part. + +{MnSRoot} := {scheme} : // {URI-DN-prefix} / {root} + +When using "{MnSRoot}" the abbreviated URI structure is given by + +{MnSRoot} / {MnSName} / {MnSVersion} / {URI-LDN} + +or + +{MnSRoot} / {MnSName} / {MnSVersion} / {URI-LDN-first-part} / {className}={id} + +It is recommended to use this abbreviated form of the URI structure when defining Management Services. + +The path segment "MnSVersion" allows access to resources with different MnS versions, for example: + + + + +Note that both URIs, though different as to the path segment indicating the version number of the ProvMnS, identify the same resource that is identified by the canonical URI: + + + +and whose DN is: + +DC=operatorA.com, SubNetwork=south, ..., Cell=1 + +The optional path component "{root}" may be used to separate the name space for 3GPP management from the name space for other domains: + + + +or to provide dedicated URIs on the same host for different tasks: + + + + +Note that when different hosts are used for different management tasks, like in + + + + +then also the resources are different and identified by the canonical URIs + + + + +or the DNs + +DC=cm.operatorA.com,SubNetwork=south,...,Cell=1 + DC=fm.operatorA.com,SubNetwork=south,...,Cell=1 + +In the example above, it is assumed that both resources represent the same cell in the network. This information cannot be derived from the DN or canonical URI, though. + +### 4.4.3 URI structure for resources not representing managed object instances + +URIs identifying other resources shall follow, when being used as a target URI in HTTP requests, the structure given by + +{scheme}:// {authority} / {root} / {MnSName} / {MnSVersion} / {MnSResourcePath} + +with: + +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------| +| {scheme} | Scheme component "http" or "https" | +| {authority} | Authority component (host identifier and optional TCP port) | +| {root} | Part of the path component, allows specifying optional path segments for structuring the resource hierarchy on a HTTP server. | +| {MnSName} | Part of the path component, specifies the mandatory MnS name in a single path segment. | +| {MnSVersion} | Part of the path component, specifies the mandatory MnS version in a single path segment. | +| {MnSResourcePath} | Part of the path component, one or more path segments, specifies a resource of the MnS | + +For the sake of brevity, {MnSRoot} is introduced that includes the "{scheme}" part, the two slash characters ("//"), the "{authority}" part, a single slash character ("/") and the "{root}" part. When using "{MnSRoot}" the abbreviated URI structure is given by + +{MnSRoot} / {MnSName} / {MnSVersion} / {MnSResourcePath} + +It is recommended to use this abbreviated form of the URI structure when defining Management Services. + +### 4.4.4 Resource "../{MnSName}/{MnSVersion}" + +The resource identified by "../{MnSName}/{MnSVersion}" is called NRM root. It represents the conceptual parent of the top-level managed object instances. It is created by the MnS Producer. A MnS Consumer cannot create or delete this resource. + +The resource is the target resource for many HTTP requests, such as requests to retrieve all top-level managed object instances in case there are multiple top-level managed object instances, or for requests to create objects in case there are no manged object instances yet and the creation request needs to be directed to the parent of the resource to be created. + +Attempts to read the NRM root only shall return "204 No Content". + +## 4.5 Response status codes + +The response status codes as defined in section 6 of RFC 7231 [2] shall be supported. + +# 5 Basic design patterns + +## 5.1 Design pattern for creating a resource + +### 5.1.1 Creating a resource with identifier creation by the MnS Producer + +Operations to create a (single) resource shall be specified with the HTTP POST method, when the MnS Producer shall create the identifier of the new resource. + +![Sequence diagram showing the flow for creating a resource with HTTP POST. The MnS Consumer sends a POST request to the MnS Producer, and the MnS Producer responds with a 201 Created or 204 No Content status.](c036e2540a94b31357ceb0002f0cacab_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. POST .../resource(ResourceRepresentation) + MnS Producer-->>MnS Consumer: 2. 201 Created (ResourceRepresentation) or 204 No Content + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +Sequence diagram showing the flow for creating a resource with HTTP POST. The MnS Consumer sends a POST request to the MnS Producer, and the MnS Producer responds with a 201 Created or 204 No Content status. + +**Figure 5.1.1-1: Flow for creating a resource with HTTP POST** + +The procedure is as follows: + +- 1) The MnS Consumer sends an HTTP POST request to the MnS Producer. The target URI identifies the parent resource below which the new resource shall be created. The target URI shall have no query and no fragment component. The message body shall carry a representation of the resource to be created. The resource representation shall not contain the identifier of the new resource, unless the resource representation format mandates the presence of a resource identifier in which case it shall carry null semantics. If the identifier carries nevertheless a value, the MnS Producer may consider that as a non-binding recommendation by the MnS Consumer. The object class name of the resource to be created shall be specified in the message body as well. +- 2) The MnS Producer returns the HTTP POST response. On success, "201 Created" shall be returned. The "Location" header shall be present and carry the URI of the new resource. The URI shall be constructed by the MnS Producer by creating an identifier for the new resource and appending a new path segment containing this identifier to the request URI. The response message body should carry the representation of the new resource. If the resource representation received is not modified, the MnS Producer may also return "204 No Content", instead of "201 Created". The response message body shall be empty in this case. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +The resource representation in the request and response message may not be identical, and may not contain all properties (attributes) that are defined in a schema specifying the format of the representation. + +For example, assume the schema for the representation of the resource defines the attributes "attrA", "attrB" and "attrC". When the MnS Consumer has valid values only for the attributes "attrA" and "attrB", then the representation sent to the MnS Producer shall include only these two attributes. When the MnS Producer has no valid value for "attrC" and no default value is defined for attrC, then the response is identical to the request, and a subsequent HTTP GET request for all attributes returns only a representation with the attributes "attrA" and "attrB", but not with the attribute "attrC". However, if the MnS Producer populates "attrC" with some value or a default value is defined for attrC, then the HTTP POST response shall include all three attributes. Likewise, a subsequent HTTP GET request for all attributes returns all three attributes. + +A MnS Producer may also modify attribute values included in the request. In this case, the modified values shall be sent back to the MnS Consumer. + +It is also possible that a MnS Producer removes attributes received in the request and includes only a subset of the received attributes in the response. + +When the created resource has child resources that are included in the schema definition of the created resource, a representation of these child resources shall neither be included in the resource representation sent to the MnS Producer nor in the resource representation returned to the MnS Consumer. Including child resources would be an attempt to create multiple resources with a single request. HTTP POST shall be used for the creation of a single resource only. + +Only resources, whose parent resource does exist, can be created (directly under that parent). The MnS Producer shall consider an attempt to create a resource, whose parent resource does not exist, as an error. + +Note that the parent resource of resources for top-level (root) managed object instances is the NRM root. The NRM root always exists on MnS producers. This ensures that, when no resources for managed object instances have been created yet, the top-level resources can be created. + +### 5.1.2 Creating a resource with identifier creation by the MnS Consumer + +Operations to create a (single) resource shall be specified with the HTTP PUT method, when the MnS Consumer creates the identifier of the new resource. + +![Sequence diagram showing the flow for creating a resource with HTTP PUT. The MnS Consumer sends a PUT request to the MnS Producer, and the MnS Producer responds with a 201 Created or 204 No Content response.](a7c51c18111139f9aca2805114108565_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. PUT .../resource(ResourceRepresentation) + MnS Producer-->>MnS Consumer: 2. 201 Created (ResourceRepresentation) or 204 No Content + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +Sequence diagram showing the flow for creating a resource with HTTP PUT. The MnS Consumer sends a PUT request to the MnS Producer, and the MnS Producer responds with a 201 Created or 204 No Content response. + +**Figure 5.1.2-1: Flow for creating a resource with HTTP PUT** + +The procedure is as follows: + +- 1) The MnS Consumer sends an HTTP PUT request to the MnS Producer. The target URI identifies the location of the resource to be created. The target URI shall have no query and no fragment component. The message body shall carry the representation of the resource to be created. The representation shall include the identifier and object class name of the new resource. +- 2) The MnS Producer returns the HTTP PUT response. On success, "201 Created" shall be returned. The Location header shall carry the URI of the new resource. The response message body shall contain the representation of the new resource. If the resource representation received is not modified, the MnS Producer may also return "204 No Content", instead of "201 Created". The response message body shall be empty in this case. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +As for resource creation with HTTP POST, the resource representation in the request and response message may not be identical and may not contain all properties (attributes) that may be defined in a schema specifying the format of the representation. Also, just like for resource creation with HTTP POST, the resource representation sent to the MnS Producer or returned to the MnS Consumer shall not contain the representation of any child resources of the resource to be created. + +As to the existence of parent resources for the resources to be created, the considerations set forth in the preceding clause for HTTP POST apply. + +## 5.2 Design pattern for reading a resource + +Operations to read the representation of a resource shall be specified with the HTTP GET method. The resource to be read is identified with a URI. + +![Sequence diagram showing the flow for reading a resource. A MnS Consumer sends a GET request to a MnS Producer, and the Producer responds with a 200 OK containing the resource representation.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. GET .../resource + MnS Producer-->>MnS Consumer: 2. 200 OK (ResourceRepresentation) + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +Sequence diagram showing the flow for reading a resource. A MnS Consumer sends a GET request to a MnS Producer, and the Producer responds with a 200 OK containing the resource representation. + +**Figure 5.2-1: Flow for reading a resource** + +The procedure is as follows: + +- 1) The MnS Consumer sends a HTTP GET request to the MnS Producer. The resource to be read is identified with the target URI. The target URI shall have no query and no fragment component. The "Accept" header shall be included in the request and contain the media types acceptable to the MnS Consumer. The message body shall be empty. +- 2) The MnS Producer returns the HTTP GET response. On success, "200 OK" shall be returned. The resource representation is carried in the response message body. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +## 5.3 Design pattern for updating a resource + +Operations to update the complete representation of a (single) resource shall be specified with the HTTP PUT method. The resource to be updated is identified with the target URI. + +![Sequence diagram showing the flow for updating a resource. A MnS Consumer sends a PUT request with a resource representation to a MnS Producer, and the Producer responds with a 200 OK or 204 No Content.](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. PUT .../resource(ResourceRepresentation) + MnS Producer-->>MnS Consumer: 2. 200 OK (ResourceRepresentation) or 204 No Content + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +Sequence diagram showing the flow for updating a resource. A MnS Consumer sends a PUT request with a resource representation to a MnS Producer, and the Producer responds with a 200 OK or 204 No Content. + +**Figure 5.3-1: Flow for updating a resource** + +The procedure is as follows: + +- 1) The MnS Consumer sends an HTTP PUT request to the MnS Producer. The resource to be updated is identified with the target URI. The target URI shall have no query and no fragment component. The message body carries the new representation that shall completely replace the existing resource representation on the MnS Producer. +- 2) The MnS Producer returns the HTTP PUT response to the MnS Consumer. On success, "200 OK" or "204 No Content" shall be returned. In the former case the response shall carry the representation of the updated resource in the message body. In the latter case the response shall have no message body. A "200 OK" response including the representation of the updated resource shall be sent when the updated representation of the resource is not identical to the representation received in the request. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. In case the resource does not exist, the resource shall be created if resource creation by MnS consumers is supported for that resource (see clause 5.1.2). + +Note that the HTTP PUT method has replace semantics and not merge semantics. A complete resource update in this context does not mean that all properties (attributes) defined by a schema for the representation of the resource need to be contained in the request, but that the existing representation on the MnS producer is replaced completely by the received representation (assuming no default values are defined for any of the attributes of the resource and the MnS Producer does not populate any of the attributes not received in the request with a value). + +For example, assume the schema for the representation of a resource defines the attributes "attrA", "attrB" and "attrC". No default value is defined for these attributes. The current representation of the resource on the MnS Producer contains only "attrA" and "attrB". + +- To update "attrA" and "attrB", the received resource representation needs to contain "attrA" with the new value and "attrB" with the new value. +- To update only "attrA", the received resource representation needs to contain "attrA" with the new value and "attrB" with the old value. Sending only a representation with "attrA" deletes "attrB" on the MnS Producer. Vice versa, to update only "attrB", the received resource representation needs to contain "attrA" with the old value and "attrB" with the new value. Sending only a representation with "attrB" deletes "attrA" on the MnS Producer. +- In case the received representation contains only "attrC" with some value, the new representation after the update contains only "attrC". The existing attributes "attrA" and "attrB" are deleted. + +As for resource creation with HTTP PUT, this behavior is modified if default values are defined for attributes or if the MnS Producer populates attributes not contained in the HTTP PUT request with values. In both cases these attributes shall be returned in the response with the default value or assigned value. + +Also, as for resource creation with HTTP PUT, a MnS Producer may modify attribute values included in the request and return the modified values to the MnS Consumer, or remove attributes received in the request and include only a subset of the received attributes in the response. + +When the target resource has child resources that are included in the schema definition of the target resource, the representation of these child resources shall neither be included in the resource representation sent to the MnS Producer nor in the resource representation returned to the MnS Consumer. The overwrite semantic of PUT refers only to the target resource and not to child resources. + +## 5.4 Design pattern for deleting a resource + +Operations to delete the representation of a (single) resource shall be specified with the HTTP DELETE method. The resource to be deleted is identified with the target URI in the request message. + +![Sequence diagram showing the flow for deleting a resource between an MnS Consumer and an MnS Producer.](29f586959675cafdf81cf934954908eb_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. DELETE .../resource + MnS Producer-->>MnS Consumer: 2. 204 No content + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +The diagram illustrates a sequence of interactions between an MnS Consumer and an MnS Producer. At the top, two boxes represent the 'MnS Consumer' and 'MnS Producer'. A dashed vertical line descends from each box. A solid horizontal arrow points from the Consumer's dashed line to the Producer's dashed line, labeled '1. DELETE .../resource'. A return arrow points from the Producer's dashed line back to the Consumer's dashed line, labeled '2. 204 No content'. At the bottom, two more boxes represent the 'MnS Consumer' and 'MnS Producer' again, with dashed vertical lines extending upwards to meet the return arrow. + +Sequence diagram showing the flow for deleting a resource between an MnS Consumer and an MnS Producer. + +Figure 5.4-1: Flow for deleting a resource + +The procedure is as follows: + +- 1) The MnS Consumer sends an HTTP DELETE request to the MnS Producer. The resource to be deleted is identified with the URI. The target URI shall have no query and no fragment component. The message body is empty. +- 2) The MnS Producer returns the HTTP DELETE response to the MnS Consumer. On success, "204 No Content" shall be returned. The response message body shall be empty. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +When resources are structured with parent-child relations in a hierarchical tree, it shall not be possible to delete other resources than leaf resources. Attempts to delete other resources shall result in an error and the "409 Conflict" status code shall be returned by the MnS Producer. + +## 5.5 Design pattern for subscribe/notify + +### 5.5.1 Concept + +HTTP is based on requests and responses. There is no built-in support for notifications and subscriptions to notifications. These mechanisms need to be modelled based on special subscription resources and the available HTTP methods. When notifications are used the server shall expose at least one subscription resource. + +### 5.5.2 Subscription creation + +To subscribe to notifications the subscriber shall send an HTTP POST request to the subscription resource. + +![Sequence diagram for creating a subscription](51db757d054ce1ce83c436a3578b56ca_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. POST .../subscription_resource(SubscriptionInformation) + MnS Producer-->>MnS Consumer: 2. 201 Created (ResourceRepresentation) + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +The diagram illustrates the interaction for creating a subscription. It features two lifelines: 'MnS Consumer' and 'MnS Producer'. The sequence starts with the MnS Consumer sending a '1. POST .../subscription\_resource(SubscriptionInformation)' message to the MnS Producer. The MnS Producer responds with '2. 201 Created (ResourceRepresentation)'. The lifelines are labeled at both the top and bottom of the diagram. + +Sequence diagram for creating a subscription + +**Figure 5.5.2-1: Flow for creating a subscription** + +The procedure is as follows: + +- 1) The MnS Consumer (notification subscriber) sends an HTTP POST request to the MnS Producer. The URI shall indicate a subscriptions collection resource. The resources representing existing subscriptions are created below the collection resource. The subscriber shall indicate in the message body the URI to which notifications will be sent (notification sink) and the type of notifications that are subscribed to. Additional filter information may be included in the message body. +- 2) The MnS Producer shall return "201 Created" on success. The message body shall carry the representation of the created subscription resource. The "Location" header shall carry the URI of the created subscription resource. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +### 5.5.3 Subscription deletion + +To cancel a subscription, the subscriber shall delete the corresponding resource with HTTP DELETE. + +![Sequence diagram for deleting a subscription](dc23d430e878eb71b8cd589984113940_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. DELETE .../subscription_resource + MnS Producer-->>MnS Consumer: 2. 204 No content + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +The diagram illustrates the interaction for deleting a subscription. It features two lifelines: 'MnS Consumer' and 'MnS Producer'. The sequence starts with the MnS Consumer sending a '1. DELETE .../subscription\_resource' message to the MnS Producer. The MnS Producer responds with '2. 204 No content'. The lifelines are labeled at both the top and bottom of the diagram. + +Sequence diagram for deleting a subscription + +**Figure 5.5.3-1: Flow for deleting a subscription** + +The procedure is as follows: + +- 1) The MnS Consumer (notification subscriber) sends an HTTP DELETE request to the MnS Producer. The URI shall indicate the subscription resource to be deleted. +- 2) The MnS Producer returns the HTTP DELETE response to the MnS Consumer. On success, "204 No Content" shall be returned. The message body shall be empty. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +### 5.5.4 Notification emission + +To send a notification on the occurrence of a notifiable event the MnS Producer sends an HTTP POST request to the notification sink. + +![Sequence diagram for notification emission](898fb89a50d9ec1dfb4e425c816976a7_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Producer->>MnS Consumer: 1. POST.../notification_sink(NotificationContent) + MnS Consumer-->>MnS Producer: 2. 204 No content + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +The diagram illustrates the interaction for sending a notification. It features two lifelines: MnS Consumer and MnS Producer. The MnS Producer sends a POST request to the MnS Consumer's notification sink. The MnS Consumer responds with a 204 No Content status. The lifelines are labeled at both the top and bottom of the sequence. + +Sequence diagram for notification emission + +**Figure 5.5.4-1: Flow for sending a notification** + +The procedure is as follows: + +- 1) The MnS Producer sends an HTTP POST request to the MnS Consumer. The URI identifies the notification sink. The notification content shall be included in the message body. +- 2) The MnS Consumer returns "204 No Content". The message body shall be empty. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +This design pattern requires the MnS Producer (HTTP server) to contain a reduced feature HTTP client for sending HTTP POST requests and receiving HTTP POST responses, and vice versa, the MnS Consumer (HTTP client) to contain a reduced feature HTTP server for receiving HTTP POST requests and sending HTTP POST responses. + +### 5.5.5 Subscription retrieval + +The subscriber can retrieve the information about a specific subscription by invoking the HTTP GET method on the URI returned by the server upon creation of this subscription. Information about all subscriptions can be read by invoking the HTTP GET method on the subscriptions collection resource. + +![Sequence diagram for subscription retrieval](f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. GET .../subscription_resource + MnS Producer-->>MnS Consumer: 2. 200 OK (ResourceRepresentation) + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +The diagram illustrates the interaction for subscription retrieval. It features two lifelines: MnS Consumer and MnS Producer. The MnS Consumer sends a GET request to the MnS Producer for a specific subscription resource. The MnS Producer responds with a 200 OK status and the resource representation. The lifelines are labeled at both the top and bottom of the sequence. + +Sequence diagram for subscription retrieval + +**Figure 5.5.5-1: Flow for subscription retrieval** + +The procedure is as follows: + +- 1) The MnS Consumer sends an HTTP GET request to the MnS Producer. The URI specifies the subscription resource or subscriptions collection resource to be read. +- 2) The MnS Producer returns the HTTP Get response. On success, "200 OK" shall be returned. The representation of the subscription resource or subscriptions collection resource shall be carried in the response message body. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +# 6 Advanced design patterns + +## 6.1 Design pattern for scoping and filtering + +### 6.1.1 Introduction + +In stage 2 specifications a scope construct is often used for selecting multiple managed object instances. The scope construct, together with a so called base managed object instance, selects a set of object instances from the name-containment tree starting at the document root. This set contains some or all object instances name-contained by the base object instance. It may contain the base object itself. + +In operations, the base object instance and the scope construct are specified as an input parameter. In NRM control fragments, the base object instance is the object instance that name-contains the control object instance of the NRM control fragment, and the scope construct is an attribute of the control object instance. + +A filter construct is also often used in stage 2 specifications to select a subset of the managed object instances selected by the base managed object instance and scope construct. The filter is specified in operations as input parameter and in NRM control fragments as an attribute of a control object. + +When scoping and filtering is specified using NRM control fragments, no special considerations are required for the REST SS, since the scope construct and the filter are normal attributes of a managed object. + +When scoping and filtering is specified as part of the input parameters of an operation, however, it is necessary to define how to map these parameters in the REST SS. + +### 6.1.2 Query parameters for scoping + +Scoping may be supported by the HTTP GET method. It is not supported by any other method. + +The URI path component identifies the base resource. The URI query component shall be used for carrying the scope construct. Multiple query parameters shall be separated by an ampersand character ("&"). + +With one query parameter the base resource and all resources until the level indicated by the query parameter can be selected. When the value of the query parameter is set to infinite, the complete subtree starting at the base resource is selected. + +Two query parameters for scoping allow for more sophisticated selection methods. + +An example scoping method uses a "scopeType" and a "scopeLevel" query parameter. The allowed values are defined in Table 6.1.2-1. + +**Table 6.1.2-1: Allowed values of the "scopeType" query parameter** + +| Value | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BASE_ONLY | Selects only the base resource. The "scopeLevel" parameter shall be absent or ignored if present. This is also the default case, when no "scopeType" query parameter is present in the request. | +| BASE_ALL | Selects the base resource and all of its descendant resources (incl. the leaf resources). The "scopeLevel" parameter shall be absent or ignored if present. | +| BASE_NTH_LEVEL | Selects all resources on the level, which is indicated by the "scopeLevel" parameter, below the base resource. The base resource is at "scopeLevel" zero. | +| BASE_SUBTREE | Selects the base resource and all of its descendant resources down to and including the resources on the level indicated by the "scopeLevel" parameter. The base resource is at "scopeLevel" zero. | + +### 6.1.3 Query parameters for filtering + +Filtering may be supported by the HTTP GET method. It is not supported by any other method. + +The URI query component shall be used for carrying the filter expression. The name of the query parameter is "filter". + +Jex [21] shall be used for specifying the filter expression. + +The Jex expression is applied to a JSON document document constructed based on the following rules: + +- The document element is the object identified by the path component of the target URI. If the path component of the target URI identifies the NRM root (see clause 4.4.4), then the element name of the document element shall be "nrmRoot". The "nrmRoot" element contains the element nodes coming from the top-level objects as its children. +- The document includes scoped objects only. +- The document is constructed with the scoped objects using the hierarchical response construction method defined in clause 6.1.4. + +A valid XPath expression returns a flat list of selected resources. Name-contained resources included in the selected resources shall be removed before constructing the final response message according to clause 6.1.4. + +The Jex expression needs to be percent-encoded as described in clause 2 and 3.4 of RFC 3986 [4]. + +Note that NRM objects and NRM attributes are both mapped to element nodes. The children of an element node representing a NRM object are hence the NRM attributes of that NRM object or the name-contained NRM objects. This needs to be taken into account when constructing a location path for selecting element nodes representing NRM objects or NRM attributes. + +### 6.1.4 Construction rules for the response message body + +When multiple resources are selected for retrieval by HTTP GET, the response message body with the selected resource set shall be constructed according to one of the following rules. + +Flat response construction method: The resources are returned as a flat list of JSON objects. Their location in the hierarchical containment tree shall be specified by, e.g., their URI or Distinguished Name (DN) which needs to be returned for each resource. The object class name of each resource should be returned as well. + +Hierarchical response construction method: The resources are returned inside the containment tree as specified by the JSON schema definition of the information model. For the resources that are not selected, the following applies: + +- A resource is not returned at all if it is not an ancestor of any of the selected resources. +- A resource is returned empty, except for the resource identifiers, if it is a descendant of the base resource and an ancestor of any of the selected resources + +The containment tree present in the response message shall always start with the base resource. + +If no resource is identified in the retrieval request the MnS Producer shall return a "204 No Content" response. + +The following media types shall be used to distinguish the flat and the hierarchical response representation: + +- application/vnd.3gpp.object-tree-flat+json, +- application/vnd.3gpp.object-tree-hierarchical+json. + +The "application/json" media type may be used alternatively and defaults to the hierarchical representation format. + +The MnS Consumer shall indicate the acceptable representations in the "Accept" header, as described in clause 4.3.2. One or multiple media types may be specified. If the MnS Producer cannot provide an acceptable representation, a "406 Not Acceptable" error response shall be returned. The MnS Consumer may send a second request with another media type specified in the "Accept" header. + +## 6.2 Design patterns for attribute and attribute field selection + +### 6.2.1 Introduction + +This design pattern allows to specify attributes of resources selected by the target URI. + +Often attributes have no scalar values but are complex structured data types with an own hierarchy and many attribute fields. In this case it may be desirable to identify not only the complete attribute but also individual attribute fields. + +The attributes or attribute fields to be returned shall be specified in the query part of the URI. + +Attribute selection or attribute field selection may be supported by the HTTP GET method. It is not applicable to any other method. + +### 6.2.2 Query parameters for attribute and attribute field selection + +In case one or more attributes (with all attribute fields) are to be retrieved, the name of the query parameter shall be "attributes". The value of "attributes" shall be a list with the names of the attributes to be selected. Attribute names are separated by a comma (","). An empty "attributes" query parameter is allowed and has the special meaning that no attributes shall be returned. The naming attribute "id" shall always be returned. + +In case one or more fields of one or more attributes are to be retrieved, the name of the query parameter shall be "fields". The value of "fields" shall be a comma (",") separated list of entries that follow the syntax of JSON Pointer in JSON String Representation [14]. The context resource for the construction of the JSON Pointer is the resource identified by the target URI. + +Note that for multi-valued attributes the selection of one or multiple attribute elements is not supported with this pattern. Furthermore, conditional attribute or attribute field selection is not supported. + +### 6.2.3 Construction rules for the response message body + +In a first step the resource identified by the target URI, or the set of resources identified by the target URI and the scope and filter parameters, is determined. Then, in a second step, resources that do not contain at least one attribute identified by the "attributes" parameter or one attribute field identified by the "fields" parameter shall be removed from the output set of the first step. In the last step all attributes and attribute fields not identified by "attributes" and "fields" shall be removed from the remaining resource representations. + +This result set is then used to construct the final response using either the hierarchical or the flat construction method, both defined in clause 6.1.4. + +If no resource is identified in the retrieval request the MnS producer shall return an error response with "404 Not Found" in the status line. + +## 6.3 Design pattern for partially updating a resource + +### 6.3.1 Introduction + +HTTP PUT allows to replace (overwrite) a complete resource on the MnS Producer with the new representation in the request body. It cannot be used for partial updates of a resource. + +For partial updates of a single resource HTTP PATCH (RFC 5789 [11]) shall be used. With PATCH, a set of changes to be applied to the target resource is described in the request message body. The set of changes carried in the message body is called patch document. The format of the patch document is identified by its media type. RFC 5789 [11] does not define any patch format, only the PATCH method. + +The HTTP PATCH method is atomic, as per RFC5789 [11]. The MnS Producer shall apply the entire set of changes atomically and never provide (e.g., in response to a GET during this operation) a partially modified representation. If the entire patch document cannot be successfully applied, then the MnS Producer shall not apply any of the changes. PATCH thus has transaction semantics. + +For JSON, IETF has defined two patch formats for the use with the HTTP PATCH method: JSON Merge Patch (RFC 7396 [12]) and JSON Patch (RFC 6902 [13]). The usage of these patch formats is described in the following clauses. + +### 6.3.2 JSON Merge Patch + +RFC 7396 [12] specifies a simple patch format for JSON documents called JSON Merge Patch. It allows to describe a set of modifications to be applied to the target resource representation. The JSON Merge Patch document is a partial representation of the resource to be patched. JSON Merge Patch works at the level of name/value pairs. The received patch document is merged into the target resource representation. The media type of the patch document is "application/merge-patch+json". + +Three types of patches are described in RFC 7396 [12]: + +- 1) Replacing the value of an already existing name/value pair by a new value. +- 2) Adding a new name/value pair. +- 3) Removing an existing name/value pair. + +The target resource is identified by the target URI. The target URI shall have no query and no fragment component. The target resource needs to exist, otherwise the error status code "404 Not Found" shall be returned. + +The "id" of the resource shall be present in the patch document and shall be identical to the "id" of the patched resource in the request URI. This ensures uniformity of resource representations in message bodies, though, strictly speaking, the presence of the "id" in the patch document is redundant. + +JSON Merge Patch does not allow manipulation of arrays other than replacing the complete array value (an array with all present items) with a new value (an array with all new items). It is not possible to change individual items in an array or to add/delete individual items. + +![Sequence diagram showing the flow for partially updating a resource with JSON Merge Patch. It involves an MnS Consumer and an MnS Producer. The Consumer sends a PATCH request to the Producer, and the Producer responds with a 200 OK or 204 No Content.](86d30a7d5a9cd4ee5456b5962ae3420a_img.jpg) + +``` +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. PATCH .../resource(PartialResourceRepresentation) + MnS Producer-->>MnS Consumer: 2. 200 OK (ResourceRepresentation) or 204 No Content + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer +``` + +Sequence diagram showing the flow for partially updating a resource with JSON Merge Patch. It involves an MnS Consumer and an MnS Producer. The Consumer sends a PATCH request to the Producer, and the Producer responds with a 200 OK or 204 No Content. + +**Figure 6.3.2-1: Flow for partially updating a resource with JSON Merge Patch** + +The procedure flow is as follows: + +- 1) The MnS Consumer sends an HTTP PATCH request to the MnS Producer. The resource to be updated is identified with the target URI. The message body shall carry the JSON Merge Patch document describing a set of modifications to be applied to the target resource. +- 2) The MnS Producer returns the HTTP PATCH response to the MnS Consumer. On success, "200 OK" together with the complete representation of the updated resource in the message body or "204 No Content" shall be returned. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +JSON Merge Patch shall be used for patching the target resource only. The patch format shall not be used for creating, modifying or deleting child resources of the target resource in the same request, even if the child resources are included in the schema definition of the target resource. This limitation is introduced, because child resources (of one object class) are represented as items of an array that is a property of the target resource (alongside with the attributes of the target resource), and JSON Merge Patch does not allow to modify individual array items. With JSON Merge Patch, only the complete array value with the representations of all child resources (of one class) could be replaced. Note that child resources can have child resources as well. The patch document would hence need to include the representations of all descendant resources. This is very inefficient and against the principle of PATCH to provide the changes only. + +The following examples demonstrate the usage of JSON Merge Patch. Assume an "XyzFunction" resource has no attribute "attrA" yet, then the following PATCH request creates it. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/merge-patch+json + +{ + "id": "XYZF1", + "attributes": { + "attrA": "abc" + } +} +``` + +The following subsequently executed PATCH request replaces its value with "def". + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/merge-patch+json + +{ + "id": "XYZF1", + "attributes": { + "attrA": "def" + } +} +``` + +This PATCH request deletes the attribute. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/merge-patch+json + +{ + "id": "XYZF1", + "attributes": { + "attrA": null + } +} +``` + +### 6.3.3 JSON Patch + +The JSON Patch format is specified in RFC 6902 [13]. The patch document is a JSON array. Each array item is a JSON object describing a modification to be applied to the target resource. The modifications shall be applied to the target resource sequentially in the order they appear in the array. The media type of JSON Patch is "application/json-patch+json". + +Each modification is defined by three properties: The operation ("op"), the identification of the secondary resource within the target resource to be manipulated ("path") and a value ("value"). When removing a secondary resource, the "value" property is absent. When moving or copying an existing value, the "value" property is absent, too, and the "from" property is present instead. The "from" property identifies the secondary resource, whose value is moved or copied to the location specified by the "path" property. The value of the "from" and "path" property is a JSON Pointer in string representation as defined in section 5 of IETF RFC 6901 [14]. + +In contrast to JSON Merge Patch, JSON Patch allows to modify individual items of an array. Array items are identified based on their position (index) in an array. The first item has the index "0". The "-" character is used by the operations "add" and "move" to index the end of the array for appending a new array item. Its use in any other operation is forbidden. + +The target URI identifies the resource to be modified. As for JSON Merge Patch, the target URI shall have no query and no fragment component. The target resource needs to exist, otherwise the error status code "404 Not Found" shall be returned. + +![Sequence diagram showing the flow for partially updating a resource with JSON Patch. A MnS Consumer sends a PATCH request to a MnS Producer, and the MnS Producer returns a 200 OK or 204 No Content response.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant MnS Consumer + participant MnS Producer + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + MnS Consumer->>MnS Producer: 1. PATCH .../resource(PartialResourceRepresentation) + MnS Producer-->>MnS Consumer: 2. 200 OK (ResourceRepresentation) or 204 No Content + Note left of MnS Consumer: MnS Consumer + Note right of MnS Producer: MnS Producer + +``` + +Sequence diagram showing the flow for partially updating a resource with JSON Patch. A MnS Consumer sends a PATCH request to a MnS Producer, and the MnS Producer returns a 200 OK or 204 No Content response. + +**Figure 6.3.3-1: Flow for partially updating a resource with JSON Patch** + +The procedure flow is as follows: + +- 1) The MnS Consumer sends an HTTP PATCH request to the MnS Producer. The resource to be updated is identified with the target URI. The message body shall carry a JSON Patch document describing a set of modification instructions to be applied to the target resource. +- 2) The MnS Producer returns the HTTP PATCH response to the MnS Consumer. On success, "200 OK" together with the representation of the updated resource in the message body or "204 No Content" shall be returned. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +As JSON Merge Patch, also JSON Patch shall be used for patching the target resource only. The patch format shall not be used for creating, modifying or deleting child resources of the target resource in the same request, even if the child resources are included in the schema definition of the target resource. This is because JSON Patch can address items in an array only based on the position of the item in the array, and not based on an identifier independent from the position of the item in the array. A patch document could hence not address descendant resources of the target resource based on their "id". This is prone to conflicts in multi-client scenarios, where the position of resource items in an array can change due to the concurrent creation or deletion of resource items in the same array. Risk mitigation would require complex ETag calculations in the resource hierarchy. + +The JSON Patch document is described by the following JSON schema fragment. + +``` + +{ + "type": "array", + "items": { + "type": "object", + "properties": { + "op": { + "enum": [ + "add", + "replace", + "remove", + "copy", + "move", + "test" + ] + }, + "from": { + "type": "string" + }, + "path": { + "type": "string" + }, + "value": {} + }, + "required": [ + "op", + "path" + ] + } +} + +``` + +The schema for the "value" property is the list (constructed with "anyOf") of the NRM schema fragments for all resource representations, and the NRM schema fragments for the values of all attributes and attribute fields. The NRM schema normally contains many NRM schema fragments of these kinds. For that reason it is normally not practicable to list all NRM schema fragments defining the allowed values of the "value" property. In addition, the resource, attribute + +or attribute field identified in the "path" property cannot be related by the schema itself to its value schema. For these reasons, the schema "{}" is normally used, which is the shorthand syntax for a schema without any type. + +The following example adds a new attribute "attrA" to an "XyzFunction" (assuming "attrA" does not exist yet). + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/attrA", + "value": "abc" + } +] +``` + +The following example replaces the value of "attrA" with "def". + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "replace", + "path": "/attributes/attrA", + "value": "def" + } +] +``` + +It is not an error if the "path" property of an "add" operation specifies an object member that exists already. In this case the value of the specified object member is replaced. The following patch request has hence the same effect as the patch request in the example above. In both cases the value of "attrA" is replaced with "def". + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/attrA", + "value": "def" + } +] +``` + +The following patch document has not the same effect as both examples above. It does not replace the value of "attrA" with a new value. Instead, it replaces the value of the "attributes" object with a value that is an object and has a single member, the "attrA" property (attribute), thereby deleting all other attributes, that may exist when the patch request is received. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "replace", + "path": "/attributes", + "value": { + "attrA": "def" + } + } +] +``` + +To remove the attribute "attrA" the MnS Consumer may send. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +``` + +``` +Content-Type: application/json-patch+json + +[ + { + "op": "remove", + "path": "/attributes/attrA", + } +] +``` + +When the attribute to be added is a JSON array, the "value" property contains an array. In the following example the array has two items of type string. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/attrB", + "value": ["abc", "def"] + } +] +``` + +To add a new item to an existing array, the "path" property needs to specify the array index where the item is to be added. For example, the following PATCH request adds the array item "xyz" after the first array item. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/attrB/1", + "value": "xyz" + } +] +``` + +Note that the "test" operation can be used to construct conditional patch requests. In the following example the "attrA" value is replaced only with "ghi" if the current value is "def", otherwise the test operation fails and the complete patch request is not applied. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "test", + "path": "/attributes/attrA", + "value": "def" + }, + { + "op": "replace", + "path": "/attributes/attrA", + "value": "ghi" + } +] +``` + +Conditional patch requests based on the "test" operation are limited to conditions related to secondary resources (attributes) of the target resource. It is not possible to point to secondary resources outside of the target resource using the "path" property. + +Multiple test operations can be combined to construct requests with multiple conditions. All conditions need to evaluate to true for the patch document to be applied. In other words, the test operations are linked with a logical "and" operator. + +## 6.4 Design patterns for patching multiple resources + +### 6.4.1 Introduction + +Clause 6.1 discusses a method for retrieving multiple resources with a single HTTP GET request. This clause specifies methods allowing to manipulate (create, update, delete) multiple resources with a single request. + +The specified methods use the HTTP PATCH method and provide extensions to the JSON Merge Patch and JSON Patch formats. As described in clause 6.3, JSON Merge Patch and JSON Patch are used for partial updates of a single resource. The extensions specified in the following clauses are designed to allow for efficient manipulation of multiple resources with a single HTTP PATCH request. The target resource and all its descendant resources are accessible with a single request. The extended patch formats are called 3GPP JSON Merge Patch and 3GPP JSON Patch. + +Note that the HTTP PATCH method is atomic as explained in clause 6.3.1. + +### 6.4.2 3GPP JSON Merge Patch + +3GPP JSON Merge Patch is a 3GPP defined extension to JSON Merge Patch (RFC 7396 [12]). It allows, using a single patch document, to update the target resource (as does JSON Merge Patch) and to update, create or delete descendant resources, which JSON Merge Patch does not allow, at least not in an efficient manner. This is achieved by relaxing for arrays that contain resources (of a single object class) as array items the constraint that the complete updated array value needs to be provided in the merge document. Instead, only resources to be manipulated are present in the patch document. These resources are identified with their "id". Resources that are not manipulated are either absent or present with their "id" only, when this is required to navigate along the containment tree to the resource to be patched. In other words, the rules of the hierarchical response construction method (clause 6.1.4) apply also when constructing the 3GPP JSON Merge Patch document. + +The merge semantic of JSON Merge Patch is hence extended to descendant resources of the target resource. Note that the behaviour of patching attributes of type array does not change in 3GPP JSON Merge Patch compared to JSON Merge Patch. The complete updated array value needs to be provided for attributes of type array also in a 3GPP JSON Merge Patch document. It is not possible to patch individual array items only. + +As for JSON Merge Patch, the target URI shall have no query and no fragment component. The target resource needs to exist, otherwise the error status code 404 (Not Found) shall be returned. The target URI shall identify a resource that is a common ancestor of the resources to be patched. The patch document itself shall start with the resource identified by the target URI. + +A resource is deleted by setting the "attributes" property of the resource to "null". In case a complete subtree is deleted, all resources from the base resource of the subtree down to the leaf resources shall be marked for deletion. When creating new resources, the object class name of the resource to be created shall be contained in the patch document for the resources to be created. + +The media type of 3GPP JSON Merge Patch is "vnd.3gpp.merge-patch+json". This media type is defined by 3GPP. It is not registered with IANA. Patch documents using this media type need to conform to the "application/json" media type. + +The procedure is as follows: + +- 1) The MnS Consumer sends an HTTP PATCH request to the MnS Producer. The message body shall carry a 3GPP JSON Merge Patch document describing a set of modification instructions to be applied to the identified resources. +- 2) The MnS Producer returns the HTTP PATCH response to the MnS Consumer. On success, "200 OK" together with the representation of the updated and created resources, constructed according to the hierarchical response construction method described in clause 6.1.4, in the message body or "204 No Content" shall be returned. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +### 6.4.3 3GPP JSON Patch + +3GPP JSON Patch is a 3GPP defined extension to JSON Patch (RFC 6902 [13]). + +Like 3GPP JSON Merge Patch, it allows, using a single patch document, to update the target resource (as does JSON Patch) and to update, create and delete descendant (primary) resources, which JSON Patch does not allow, at least not based on resource identifiers. + +This extension is that the "path" and "from" properties of a patch operation define a generalized offset to the target resource specified by the request URI, that allows to define not only secondary resources (within the target URI), as does JSON Patch, but also other (primary) resources and secondary resources within these other (primary) resources. The offset is relative to the target URI. It has a first component pointing (together with the target URI) to a resource below the target resource, or to the target resource, if the first component is absent. The second component points to a secondary resource within the resource identified by the first component and the request URI. When multiple root resources are to be patched, the target URI shall identify the NRM root. + +The first component of "path" or "from" is built from URI path components. It follows the same syntax as the path components of the target URI. The second component is a URI fragment with a JSON pointer in the URI fragment identifier representation as defined in clause 6 of RFC 6901 [14], i.e. the second component starts with the "#" character. Both components are concatenated without a delimiter. + +For example, assume the target URI is "/SubNetwork=SN1" and the "userLabel" attribute of a child resource of class "ManagedElement" with the id "ME1" is to be patched, then the first path component is "/ManagedElement=ME1" and the second path component is "#attributes/userLabel". This results in the following path: + +"path": "/ManagedElement=ME1/#attributes/userLabel". + +Note that the MnS producer has normally a choice as to the target resource. For example, assume the resource with the URI + +"http://example.com/3gpp/ProvMnS/v 1700/ManagedElement=ME1/XyzFunction=XYZF1" + +is patched. Then the target resource is either the patched resource + +"/example.com/3gpp/ProvMnS/v 1700/ManagedElement=ME1/XyzFunction=XYZF1", + +or the parent resource of the patched resource, in this case the root resource, + +"/example.com/3gpp/ProvMnS/v1700/ManagedElement=ME1", + +or the NRM root. + +"/example.com/3gpp/ProvMnS/v1700". + +Setting the target resource always to the NRM root is hence a possible implementation option for MnS Consumers. + +The target resource identified by the target URI needs to exist, otherwise the error status code "404 Not Found" shall be returned. + +When creating new resources ("op"="add"), the object class name of the resource to be created shall be included in the "value" property of the operation. The "replace" operation is not applicable when the "path" identifies a (primary) resource. + +The media type of 3GPP JSON Patch is "3gpp-patch+json". This media type is defined by 3GPP and is not registered with IANA. Patch documents using this media type need to conform to the "application/json" media type. + +The procedure is as follows: + +- 1) The MnS Consumer sends a HTTP PATCH request to the MnS Producer. The message body carries a 3GPP JSON Patch document describing a set of modification instructions (patch items) to be applied to the identified resources. The "Accept" header shall be included in the request and specify the media types acceptable to the MnS Consumer for "200 OK" or "204 No Content" responses. +- 2) The MnS Producer returns the HTTP PATCH response to the MnS Consumer. On success, "200 OK" together with the representation of the updated and created resources, constructed according to either the flat or hierarchical response construction method described in clause 6.1.1, in the message body or "204 No Content" shall be returned. On failure, the appropriate error code shall be returned. The response message body may provide additional error information. + +A single operation in a 3GPP JSON Patch document shall patch a single (primary) resource only. Different operations in a patch document can patch different resources though. The consequence of this restriction is for example that subtrees with multiple resources cannot be created or deleted with a single patch operation. Each resource needs to be created or deleted with an own patch operation in the patch document. This behaviour is aligned with those of the PUT and DELETE methods. + +Note that the "replace" operation of (3GPP) JSON Patch has replace semantics like PUT and not merge semantics like JSON Merge Patch. When multiple attributes or attribute fields of a resource are patched, then a patch operation for each update is required, for example: + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "replace", + "path": "#/attributes/userLabel", + "value": "Berlin NW-1" + }, + { + "op": "replace", + "path": "#/attributes/plmnId/mcc", + "value": 654 + } +] +``` + +To streamline partial updates of single resources, 3GPP JSON Patch introduces a new patch operation named "merge". For that operation, the JSON object contained in the "value" property shall be merged into the target resource referenced by "path" using the rules of JSON Merge Patch (RFC 7396 [12]). An MnS Producer shall verify if a "merge" operation is for a single resource by checking if the "path" property contains the string "#/attributes" and shall reject the request with "422 Unprocessable Entity" if it doesn't. The "merge" operation does not allow to delete secondary resources. + +With the "merge" operation, the updates in the previous example can be expressed as follows. + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "merge", + "path": "#/attributes", + "value": { + "userLabel": "Berlin NW-1", + "plmnId": { + "mcc": 654 + } + } + } +] +``` + +The following example is invalid. It attempts to patch, besides the target resource, which is allowed, the contained "ManagedElement" resources, which is not allowed. + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "merge", + "path": "", + "value": { + "attributes": { + "userLabel": "Berlin NW-1", + "plmnId": { + "mcc": 654 + } + } + } + }, +] +``` + +``` + + "ManagedElement": [ + { + ... + } + ] + } +} +] + +``` + +In the same way as JSON Patch allows to construct conditional patch requests using the "test" operation, 3GPP JSON Patch can be used to construct conditional patch requests where the condition is expressed with the "test" operation. In contrast to JSON Patch, however, the condition may be based on attribute values outside of the patched resource. + +For example, the following patch document replaces the value of "attrA", which is an attribute of a "XyzFunction" resource whereas the condition relates to an attribute in the "SubNetwork" resource. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json +Accept: application/json +[ + { + "op": "test", + "path": "#/attributes/userLabel", + "value": "Berlin NW" + }, + { + "op": "replace", + "path": "/ManagedElement=ME1/XyzFunction=XYZF1#/attributes/attrA", + "value": "ghi" + } +] + +``` + +## 6.5 Design pattern for large queries + +Clauses 6.1 and 6.2 have introduced a pattern that allows querying resources by passing query parameters in the query part of the target URI of a GET request. However, there can be scenarios where the query string can get very long, exceeding the URI length that can be expected to be supported by all implementations. + +IETF RFC 7130 [5] recommends that a request URI length of at least 8000 octets should be supported. Further, IETF RFC 7130 [5] requires that implementations shall respond with 414 (URI Too Long) in case the actual request URI is longer than the supported request URI length. + +When the URI length exceeds the supported limit, the query may be passed in the payload body of a POST request instead of the target URI of a GET request. To signal that the semantics of this POST request is actually the same as a GET request, the "X-HTTP-Method-Override: GET" HTTP header shall be included in the request. + +If the data format of the query in the POST request payload body is a list of name-value pairs separated by the "&" character (as defined in clauses 6.1 and 6.2 of the present document), the "Content-Type" header of the POST request shall be set to "application/x-www-form-urlencoded". Using other data formats for long queries and signalling them appropriately in the "Content-Type" request header is possible but needs to be documented in the specific MnS documentation. + +## 6.6 Design pattern for error responses + +### 6.6.1 Introduction + +If an error occurs on a MnS Producer during the processing of an HTTP request, the MnS Producer does not apply the request and returns an error response to the MnS Consumer. + +This clause describes first HTTP status codes to be used in error responses and then different error response message body formats. + +Note that the case of partial success, i.e. the case where some parts of the request are applied and some are not, is not covered by this clause. + +### 6.6.2 HTTP error codes + +A status code of the classes 4xx (Client Error) or 5xx (Server Error) is returned to the MnS Consumer in the error response status line. A complete list of error status codes is maintained by IANA. + +Tables 6.6.2-1 and 6.6.2-2 list the status codes that shall be supported by MnS Producer and MnS Consumer implementations compliant to this specification. + +**Table 6.6.2-1: Supported 4xx client error status codes** + +| Error status code | Reference | Description | +|-----------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 400 Bad Request | IETF RFC 7231 [2] | indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). | +| 403 Forbidden | IETF RFC 7231 [2] | indicates that the server understood the request but refuses to authorize it. | +| 404 Not Found | IETF RFC 7231 [2] | indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | +| 405 Method Not Allowed | IETF RFC 7231 [2] | indicates that the method received in the request-line is known by the origin server but not supported by the target resource. | +| 406 Not Acceptable | IETF RFC 7231 [2] | indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request (Section 5.3), and the server is unwilling to supply a default representation. | +| 408 Request Timeout | IETF RFC 7231 [2] | indicates that the server did not receive a complete request message within the time that it was prepared to wait. | +| 409 Conflict | IETF RFC 7231 [2] | indicates that the request could not be completed due to a conflict with the current state of the target resource. | +| 410 Gone | IETF RFC 7231 [2] | indicates that access to the target resource is no longer available at the origin server and that this condition is likely to be permanent. | +| 411 Length Required | IETF RFC 7231 [2] | indicates that the server refuses to accept the request without a defined Content-Length field containing the length of the message body in the request message. | +| 413 Payload Too Large | IETF RFC 7231 [2] | indicates that the server is refusing to process a request because the request payload is larger than the server is willing or able to process. | +| 414 URI Too Long | IETF RFC 7231 [2] | indicates that the server is refusing to service the request because the request-target is longer than the server is willing to interpret. | +| 415 Unsupported Media Type | IETF RFC 7231 [2] | indicates that the origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource. | +| 422 Unprocessable Entity | IETF RFC 4918 [17] | indicates the server understands the content type of the request entity (hence a 415(Unsupported Media Type) status code is inappropriate), and the syntax of the request entity is correct (thus a 400 (Bad Request) status code is inappropriate) but was unable to process the contained instructions. | +| 426 Upgrade Required | IETF RFC 7231 [2] | indicates that the server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. | +| 429 Too Many Requests | IETF RFC 6585 [18] | indicates that the user has sent too many requests in a given amount of time ("rate limiting"). | +| 451 Unavailable For Legal Reasons | IETF RFC 7725 [20] | Identifies the entity that blocks access to a resource following receipt of a legal demand. | + +**Table 6.6.2-2: Supported 5xx server error status codes** + +| Error status code | Reference | Description | +|-------------------|-----------|-------------| +|-------------------|-----------|-------------| + +| | | | +|--------------------------------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 500 Internal Server Error | IETF RFC 7231 [2] | Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. | +| 501 Not Implemented | IETF RFC 7231 [2] | indicates that the server does not support the functionality required to fulfill the request. | +| 502 Bad Gateway | IETF RFC 7231 [2] | indicates that the server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request. | +| 503 Service Unavailable | IETF RFC 7231 [2] | indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. | +| 504 Gateway Timeout | IETF RFC 7231 [2] | indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. | +| 505 HTTP Version Not Supported | IETF RFC 7231 [2] | indicates that the server does not support, or refuses to support, the major version of HTTP that was used in the request message. | + +A MnS Producer may use other error response codes as well. However, there is no guarantee that a MnS Consumer understands the semantics beyond what is specified in clause 6 of IETF RFC 7231 [2]: "A client MUST understand the class of any status code, as indicated by the first digit, and treat an unrecognized status code as being equivalent to the x00 status code of that class". + +### 6.6.3 Error response body + +#### 6.6.3.1 Overview + +HTTP status codes provide high level error information. This is often not sufficient, for example in situations where the MnS Producer wants to aid the MnS Consumer in generating a valid request. In these cases, the MnS Producer needs to include an error response body in the response, that contains more details on the error than the error code can provide. + +The error response body specified in the present document is an extension of the problem details object defined in IETF RFC 7807 [19]. The following three properties of the problem details object are re-used for describing a problem: + +- The optional "status" property that contains the status code for the error. +- The mandatory "type" property that provides high level error information. +- The optional "title" that provides a short, human-readable summary of the problem type. It shall not change from occurrence to occurrence of the problem. + +Potential support for the "details" and "instance" properties is outside the provisions of the present document. + +The three re-used properties are extended in the present document with the following property: + +- The optional "reason" property" that provides more details on the error conditions than the "type" property. + +The "status", "type", "title" and "reason" property are called generic problem details properties. They are applicable to all HTTP methods and request media types. In addition, the following method specific properties are defined: + +- The optional "badQueryParams" property that provides information about bad query parameters in GET requests. +- The mandatory "badOp" property that specifies the operation in JSON Patch and 3GPP JSON Patch requests, that cannot be satisfied. +- The optional "badAttributes" property provides information about bad attributes in PUT, POST, JSON Merge Patch and 3GPP JSON Merge Patch requests. +- The optional "badObjects" property provides information about bad objects in 3GPP JSON Merge Patch requests. + +A single request may have more than one problem. This situation may occur for example when a GET request has multiple bad query parameters, or when a PATCH request contains multiple bad operations. For that reason the optional "otherProblems" property is provided that allows to return one ore more additional problem detail descriptions. + +A MnS Consumer cannot assume that the returned list of problems is exhaustive and includes all problems in the request. A MnS producer may stop processing the request upon detection of the first problem and return an error response. + +If all problems have the same error status code, that code shall be used in the status line of the error response. The "status" property of each problem description may repeat that code. However, if the problems have different error codes, the "207 Multi-Status" (IETF RFC4918 [???]) code shall be used in the response status line. The "status" property related to each problem shall contain the specific status code. + +The concrete format of the error response body depends on the request. The media type for all error response formats is "application/vnd.3gpp.error+json". The following clauses provide the details. + +#### 6.6.3.2 Error response format for GET requests + +Each problem is described by the generic problem detail properties, and the additional "badQueryParams" property. The "type" property shall be present. The "status" property shall be present only under the conditions specified in clause X.2.1. + +A MnS Consumer cannot assume that the returned list of bad query parameters in "badQueryParams" includes all bad parameters in the request. A MnS Producer may stop processing the request upon detection of the first bad query parameter and return an error response. + +The JSON schema for the error response body is as follows. + +``` +{ + "type": "object", + "properties": { + "status": {"type": "string"}, + "type": {"type": "string"}, + "reason": {"type": "string"}, + "title": {"type": "string"}, + "badQueryParams": {"type": "array", "items": {"type": "string"}}, + "otherProblems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": {"type": "string"}, + "type": {"type": "string"}, + "reason": {"type": "string"}, + "title": {"type": "string"}, + "badQueryParams": {"type": "array", "items": {"type": "string"}} + } + } + } + }, + "required": ["type"] +}, +{"type": "array", "items": {"type": "string"}}, +{"type": "array", "items": {"type": "string"}} +] +``` + +#### 6.6.3.3 Error response format for PUT, POST, DELETE, JSON Merge Patch and 3GPP JSON Merge Patch requests + +The error response is a JSON array of JSON objects with the generic problem details, and the "badAttributes" and "badObjects" properties. The "type" property shall be present. The "status" property shall be present only under the conditions specified in clause 6.6.3. The "badObjects" property is applicable only for 3GPP JSON Merge Patch. + +The value of "badAttributes" or "badObjects" is a pointer referencing the bad node. The pointer is a relative URI and constructed according to the rules defined in clause 6.4.3 for the "path" property of 3GPP JSON Merge Patch. + +A MnS Consumer cannot assume that the returned list of bad attributes in "badAttributes" or bad objects in "badObjects" includes all bad attributes or bad objects in the request. A MnS Producer may stop processing the request upon detection of the first bad attribute or object and return an error response. + +The JSON schema for the error response body is as follows. + +``` +{ +``` + +``` + +"type": "object", +"properties": { + "status": {"type": "string"}, + "type": {"type": "string"}, + "reason": {"type": "string"}, + "title": {"type": "string"}, + "badAttributes": {"type": "array", "items": {"type": "string"}}, + "badObjects": {"type": "array", "items": {"type": "string"}}, + "otherProblems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": {"type": "string"}, + "type": {"type": "string"}, + "reason": {"type": "string"}, + "title": {"type": "string"}, + "badAttributes": {"type": "array", "items": {"type": "string"}}, + "badObjects": {"type": "array", "items": {"type": "string"}} + } + } + }, + "required": ["type"] +}, +"required": ["type"] +} + +``` + +#### 6.6.3.4 Error response format for JSON Patch and 3GPP JSON Patch requests + +Each problem is described by the generic problem detail properties, and the additional "badOp" property. The "type" and "badOp" properties shall be present. The "status" property shall be present only under the conditions specified in clause 6.6.3. + +The patch operation, that cannot be satisfied, is identified with "badOp", whose value is a JSON Pointer identifying the object with the bad patch operation in the request body. + +The JSON schema for the error response body is as follows. + +``` + +{ + "type": "object", + "properties": { + "status": {"type": "string"}, + "type": {"type": "string"}, + "reason": {"type": "string"}, + "title": {"type": "string"}, + "badOp": {"type": "string"}, + "otherProblems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": {"type": "string"}, + "type": {"type": "string"}, + "reason": {"type": "string"}, + "title": {"type": "string"}, + "badOp": {"type": "string"} + } + } + }, + "required": ["type", "badOp"] + }, + "required": ["type", "badOp"] +} + +``` + +### 6.6.4 The "type" property + +The "type" property provides high level error information allowing to complement HTTP 4xx and 5xx error codes in case this is necessary or desired. It provides more details on the nature of the problem than the HTTP error codes. Problem types are specified for the following error response codes. + +- 400 Bad Request +- 403 Forbidden +- 422 Unprocessable Content +- 500 Internal Server Error +- 503 Service Unavailable + +Note that some error codes convey already all information that can be conveyed. For example, the "404 Not Found" status code indicates that the target resource does not exist or has no current representation. It is hard to see which information should be added to make the error response more helpful for the MnS Consumer. + +The "type" property is an enumeration of string values. A MnS Producer should use the following values. Other values may be used as well if deemed more appropriate for specific errors. + +- **VALIDATION\_ERROR** (HTTP error code: 400 Bad Request): The request message does not validate and cannot be processed. Validation refers to two aspects: Validation of the received request message against the JSON schema definition of the request message, and validation of the information model state after applying the requested changes against the JSON schema definition of the information model, for example, if a new instance of a certain object class is allowed to be contained under the class of the specified parent object. +- **REQUEST\_OBJECT\_TREE\_MISMATCH** (HTTP error code: 422 Unprocessable Entity): The request message is well formed and understood but cannot be completed due to the current state of the object tree on the MnS Producer. For example, this reason is used when an object is requested to be created below a parent object that does not exist. +- **IE\_NOT\_FOUND** (related error code: 400 Bad Request): The information element (object, attribute, attribute field, attribute element) requested to be modified does not exist. +- **MODIFICATION\_NOT\_ALLOWED** (HTTP error code: 403 Forbidden): The requested modification is correct and understood but not allowed. +- **RETRIEVAL\_NOT\_ALLOWED** (HTTP error code: 403 Forbidden): The retrieval request is well formed and understood but the retrieval of the specified information is not allowed. +- **SERVER\_LIMITATION** (HTTP error code: 500 Internal Server Error): The request is well formed and understood by the MnS Producer, but the MnS Producer cannot satisfy the request due to server limitations. +- **SERVICE\_DISABLED** (HTTP error code: 503 Service Unavailable): The MnS Producer has disabled itself and is currently unable or unwilling to handle the request. This condition may occur, for example, in overload situations. +- **APPLICATION\_LAYER\_ERROR** (HTTP error code: 500 Internal Server Error): The request is well formed and understood by the MnS Producer, but the MnS Producer cannot satisfy the request due to application layer issues. + +### 6.6.5 The "reason" property + +#### 6.6.5.1 Overview + +The "reason" property provides more details on the error conditions than the "type" property. For client-side errors, these reasons may provide hints to the MnS Consumer on how to generate a request without errors. For server-side errors, they may help the MnS Consumer to generate requests that may be satisfied by the MnS Producer. + +When multiple reasons apply, the most fundamental reason should be put in the "reasons" property. For example, when a MnS Consumer attempts to replace an invariant attribute, and - in addition - the attribute value is invalid, then only the information that the attribute is invariant shall be contained in the "reason" property. + +The "reason" property may be omitted when the MnS Producer does not want to disclose details on the error to the MnS Consumer. + +Detailed error reasons are specified by the "reason" property for the following error codes: + +- 400 Bad Request +- 403 Forbidden +- 422 Unprocessable Entity +- 500 Internal Server Error + +Error reasons depend on the HTTP method, the patch format, and on if attributes or objects are manipulated. The following clauses specify error reasons for the different cases. The provided reasons are not exhaustive. Other values may be used as well. The name style of these enumeration literals shall follow clause 5.3.5.3 of 3GPP TS 32.156 [?]. + +#### 6.6.5.2 Error reasons for GET + +Valid values for the "reason" property for an error response related to HTTP GET are: + +- RESPONSE\_TOO\_LARGE (related type: SERVER\_LIMITATION, 500 Internal Server Error): The content requested to be returned exceeds the response body size limit of the MnS Producer. +- NO\_DATA\_ACCESS (related type: SERVER\_LIMITATION, 500 Internal Server Error): The request is correct and understood by the MnS Producer, but the MnS Producer cannot access the requested data. +- QUERY\_MALFORMED (related type: VALIDATION\_ERROR, 400 Bad Request): The syntax of the query component is malformed. The "badQueryParams" property shall be absent. +- QUERY\_PARAM\_NAMES\_INVALID (related type: VALIDATION\_ERROR, 400 Bad Request): One or more query parameter names are invalid. The "badQueryParams" property shall indicate the names of the invalid parameters. +- QUERY\_PARAM\_VALUES\_INVALID (related type: VALIDATION\_ERROR, 400 Bad Request): One or more query parameters have an invalid value. The "badQueryParams" property shall indicate the names of the parameters with invalid value. +- QUERY\_PARAMS\_MISSING (related type: VALIDATION\_ERROR, 400 Bad Request): One or more query parameters, that shall be present in the request or that shall be present in case another parameter is present, are missing in the query component. The "badQueryParams" property shall indicate the names of the missing parameters. +- QUERY\_PARAMS\_INCONSISTENT (related type: VALIDATION\_ERROR, 400 Bad Request): Query parameters with mutual dependency constraints do not respect these constraints. The "badQueryParams" property shall indicate the names of the parameters not respecting the dependency constraints. +- ATTRIBUTES\_NOT\_READABLE (related type: RETRIEVAL\_NOT\_ALLOWED, 403 Forbidden): One or more attributes or attribute fields identified by the query parameters are not readable, according to the attribute property "isReadable". The "badQueryParams" property shall indicate the names of the parameters identifying attributes that are not readable. +- QUERY\_PARAMS\_TOO\_COMPLEX (related type: SERVER\_LIMITATION, 500 Internal Server Error): The query parameters and their values are valid but one or more of them cannot be processed as requested because complexity limits of the MnS Producer are reached, for example, a filter expression is syntactically correct but cannot be evaluated and yields no results since the expression is longer or more complex than the MnS producer can or is willing to process. The "badQueryParams" property shall indicate the names of the parameters that cannot be processed. + +It is not an error when query parameters do not identify anything to be returned. + +Note that the following query parameters are currently specified in the present document: "scopeType", "scopeLevel", "filter", "attributes", and "fields". + +##### Examples: + +Consider the following request: + +``` +GET /SubNetwork=SN1?scopeType=COMPLETE SUBTREE&scopeLevel=HIGHEST&\ +attributeFields=userLabel HTTP/1.1 +``` + +``` +Host: example.org +Accept: application/json +``` + +The "scopeType" and "scopeLevel" query parameters have invalid values. The query parameter "attributeField" is not defined. All problems have the same HTTP error status code. The error response may look like: + +``` +HTTP/1.1 400 Bad Request +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "type": "VALIDATION ERROR", + "reason": "QUERY PARAM VALUES INVALID", + "title": "The value of one or more query parameters is invalid.", + "badQueryParams": ["scopeType", "scopeLevel"], + "otherProblems": [ + { + "type": "VALIDATION ERROR", + "reason": "QUERY_PARAM_VALUES_INVALID", + "title": "The name of one or more query parameters is invalid.", + "badQueryParams": ["attributeFields"] + } + ] +} +``` + +In the next example the "scopeType" and "scopeLevel" query parameters have invalid values and the "fields" value is syntactically correct and valid, but too complex for the MnS Producer to process. In this case the problems have different HTTP error codes. The "207 Multi-Status" code is used in the response status line, and the "status" property of each problem details object contains the status code of that problem. + +``` +HTTP/1.1 207 Multi-Status +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "status": 400, + "type": "VALIDATION ERROR", + "reason": "QUERY PARAM VALUES INVALID", + "title": "The value of one or more query parameters is invalid.", + "badQueryParams": ["attributes", "fields"], + "problemDetails": [ + { + "status": 400, + "type": "VALIDATION ERROR", + "reason": "QUERY_PARAM_NAMES_INVALID", + "title": "The name of one or more query parameters is invalid.", + "badQueryParams": ["attributeFields"] + }, + { + "status": 500, + "type": "SERVER LIMITATION", + "reason": "QUERY_PARAMS_TOO_COMPLEX", + "title": "The semantics of one or more query parameters is too complex to be processed.", + "badQueryParams": ["fields"] + } + ] +} +``` + +#### 6.6.5.3 Error reasons for attribute manipulations + +##### 6.6.5.3.1 JSON Patch and 3GPP JSON Patch + +This clause specifies reasons for errors that may occur when attempting to manipulate attributes of existing resources with JSON Patch and 3GPP JSON Patch. JSON Patch and 3GPP JSON Patch are used for partial resource updates. + +This specification defines the following error reasons for use with JSON Patch and 3GPP JSON Patch: + +- **NEW\_ATTRIBUTE\_VALUE\_INVALID** (related type: **VALIDATION\_ERROR**, 400 Bad Request): The attribute, attribute field or attribute element, as specified in the "path" property, cannot be added, or its value cannot be replaced, as requested, because the value, as specified in the "value" property, is invalid. Valid values + +are determined by the attribute properties "type", "allowedValues", "multiplicity", "isOrdered", "isUnique", and "isNullble". + +- NEW\_ATTRIBUTE\_NAME\_INVALID (related type: VALIDATION\_ERROR, 400 Bad Request): The attribute or attribute field cannot be added as requested, because its name, as specified in the "path" property, is invalid. +- NEW\_ATTRIBUTE\_PARENT\_NOT\_FOUND (related type: REQUEST\_OBJECTS\_MISMATCH, 422 Unprocessable Entity): The attribute or attribute field cannot be added as requested, because its parent, as specified in the "path" property, does not exist. +- ATTRIBUTE\_NOT\_FOUND (related type: IE\_NOT\_FOUND, 400 Bad Request): The attribute or attribute field cannot be removed, moved, copied, or its value cannot be replaced, as requested, because the "path" or "from" property identifies an attribute or attribute field, that does not exist. +- ATTRIBUTE\_ELEMENT\_NOT\_FOUND (related type: IE\_NOT\_FOUND, 400 Bad Request): The attribute element cannot be replaced, removed, moved, or copied, because the "path" or "from" property identifies an attribute element, that does not exist. +- ATTRIBUTE\_INDEX\_BAD (related type: IE\_NOT\_FOUND, 400 Bad Request): The attribute element cannot be added at the specified array location as requested, because the array element index specified in the "path" property is greater than the number of elements in the array. +- FINAL\_MV\_ATTRIBUTE\_VALUE\_INVALID (related type: REQUEST\_OBJECTS\_MISMATCH, 422 Unprocessable Entity): The attribute element, as specified in the "value" property cannot be added to or removed from the multi-valued attribute as requested, because this would result in an invalid value, according to the attribute properties "multiplicity" or "isUnique". The attribute element itself is valid. +- ATTRIBUTE\_NOT\_WRITABLE (related type: MODIFICATION\_NOT\_ALLOWED, 403 Forbidden): The attribute or attribute field cannot be added, removed, or moved, or its value cannot be replaced, as requested, because the attribute or attribute field is not writable by MnS Consumers, according to the attribute property "isWritable". +- ATTRIBUTE\_INVARIANT (related type: MODIFICATION\_NOT\_ALLOWED, 403 Forbidden): The attribute or attribute field cannot be added, removed, or moved, or its value cannot be replaced, as requested, because the attribute or attribute field is invariant, according to the attribute property "isInvariant". +- OP\_UNKNOWN (related type: VALIDATION\_ERROR, 400 Bad Request): The patch operation specified by the "op" property is not known by the MnS producer. This situation may occur, for example, when a patch operation is not supported or wrongly spelled. + +###### Examples: + +In this example the attribute field "attrB" is requested to be replaced with a new value. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "replace", + "path": "/attributes/attrA/attrB", + "value": "def" + } +] +``` + +When "attrB" is invariant and its value cannot be replaced after object creation, the error response may look like: + +``` +HTTP/1.1 403 Not Forbidden +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "type": "MODIFICATION_NOT_ALLOWED", + "reason": "ATTRIBUTE_INVARIANT", + "title": "The attribute, whose value is requested to be replaced, is invariant.", + "badOp": "/0" +} +``` + +##### 6.6.5.3.2 JSON Merge Patch, 3GPP JSON Merge Patch and PUT + +This clause specifies reasons for errors that may occur when attempting to manipulate attributes of existing resources with JSON Merge Patch, 3GPP JSON Merge Patch and PUT. JSON Merge Patch and 3GPP Merge JSON Patch are used for partial resource updates. PUT is used for complete resource updates. + +The following error reasons are defined for use with JSON Merge Patch, 3GPP JSON Merge Patch, and PUT: + +- NEW\_ATTRIBUTE\_VALUE\_INVALID (related type: VALIDATION\_ERROR, 400 Bad Request): One or more attributes or attribute fields cannot be added, or their values cannot be replaced, as requested, because the received value is invalid. Valid values are determined by the attribute properties "type", "allowedValues", "multiplicity", "isOrdered", "isUnique", and "isNullable". The "badAttributes" property provides the path to these attributes and attribute fields. +- NEW\_ATTRIBUTE\_NAME\_INVALID (related type: VALIDATION\_ERROR, 400 Bad Request): One or more attributes or attribute fields cannot be added as requested, because the received attribute or attribute field name is invalid. The "badAttributes" property provides the path to these attributes and attribute fields. +- ATTRIBUTE\_NOT\_WRITABLE (related type: MODIFICATION\_NOT\_ALLOWED, 403 Forbidden): One or more attributes or attribute fields cannot be added or removed, or their values cannot be replaced, as requested, because the attributes or attribute fields are not writable by MnS Consumers, according to the attribute property "isWritable". The "badAttributes" property provides the path to these attributes and attribute fields. +- ATTRIBUTE\_INVARIANT (related type: MODIFICATION\_NOT\_ALLOWED, 403 Forbidden): One or more attributes or attribute fields cannot be added or removed, or their values cannot be replaced, as requested, because the attributes or attribute fields are invariant, according to the attribute property "isInvariant". The "badAttributes" property provides the path to these attributes and attribute fields. + +The following additional error reasons are defined for use with JSON Merge Patch and 3GPP JSON Merge Patch: + +- ATTRIBUTE\_NOT\_FOUND (related type: IE\_NOT\_FOUND, 400 Bad Request): One or more attribute or attribute fields cannot be removed as requested, because they do not exist. The "badAttributes" property provides the path to these attributes and attribute fields. + +###### Examples: + +In this example the MnS Consumer requests to replace the current value of "attrB" with "def". + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-merge-patch+json + +{ + "id": "XYZF1", + "attributes": { + "attrA": { + "attrB": "def" + } + } +} +``` + +When "attrB" is invariant the MnS Producer might respond as follows. + +``` +HTTP/1.1 403 Forbidden +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "type": "MODIFICATION_NOT_ALLOWED", + "reason": "ATTRIBUTE_INVARIANT", + "title": "The attribute field, whose value is requested to be replaced, is invariant.", + "badAttributes": ["#/attributes/attrA/attrB"] +} +``` + +#### 6.6.5.4 Error reasons for object manipulations + +The following reasons are defined for errors that may occur when attempting to create objects with PUT, POST, 3GPP JSON Merge Patch and 3GPP JSON Patch, or when attempting to delete objects with DELETE, 3GPP JSON Merge Patch and 3GPP JSON Patch: + +- OBJECT\_CREATION\_NOT\_ALLOWED (related type: MODIFICATION\_NOT\_ALLOWED, 403 Forbidden): One or more objects cannot be created as requested because objects of this class cannot be created by MnS Consumers. +- OBJECT\_DELETION\_NOT\_ALLOWED (related type: MODIFICATION\_NOT\_ALLOWED, 403 Forbidden): One or more objects cannot be deleted as requested, because objects of this class cannot be deleted by MnS Consumers. +- NEW\_OBJECT\_CLASS\_NAME\_INVALID (related type: VALIDATION\_ERROR, 400 Bad Request): One or more objects cannot be created as requested, because the receive object class name is unknown to the MnS Producer. +- NEW\_OBJECT\_REPRESENTATION\_INVALID (related type: VALIDATION\_ERROR, 400 Bad Request): One or more objects cannot be created as requested, because the received object representation does not validate. +- NEW\_OBJECT\_CONTAINMENT\_INVALID (related type: VALIDATION\_ERROR, 400 Bad Request): One or more objects cannot be created under the specified parent as requested, because this containment is not allowed. +- NEW\_OBJECTS\_ID\_EXISTS (related type: REQUEST\_OBJECTS\_MISMATCH, 422 Unprocessable Content): One or more objects cannot be created as requested, because the received "id" exists already under the specified parent. +- NEW\_OBJECTS\_PARENT\_NOT\_FOUND (related type: REQUEST\_OBJECTS\_MISMATCH, 422 Unprocessable Content): One or more objects cannot be created as requested, because their specified parents do not exist. +- NEW\_OBJECT\_ATTRIBUTE\_VALUE\_MISSING (related type: VALIDATION\_ERROR, 400 Bad Request): One or more objects cannot be created as requested, because attribute or attribute field values, that shall be provided in the creation request, are not provided. +- OBJECTS\_CARDINALITY\_INVALID (related type: REQUEST\_OBJECTS\_MISMATCH, 422 Unprocessable Content): One or more objects cannot be created or deleted as requested, because this would result in violating cardinality constraints. +- OBJECT\_NOT\_A\_LEAF (related type: REQUEST\_OBJECTS\_MISMATCH, 422 Unprocessable Content): One or more objects cannot be deleted as requested, because they are not leaf objects. +- OBJECT\_NOT\_FOUND (related type: IE\_NOT\_FOUND, 400 Bad Request): One or more objects cannot be deleted as requested, because they do not exist. +- OP\_UNKNOWN (related type: VALIDATION\_ERROR, 400 Bad Request): The patch operation specified by the "op" property is not known by the MnS Producer. This situation may occur, for example, when a patch operation is not supported or wrongly spelled. + +The error reason "NEW\_OBJECT\_REPRESENTATION\_INVALID" provides no information on why the representation of the resource requested to be created is invalid. A MnS Producer may decide to provide more details by specifying the error reasons related to attributes defined in clause X.4.3.2 instead of the general reason "NEW\_OBJECT\_REPRESENTATION\_INVALID". The attributes or attribute fields with problems are specified by the "badAttributes" property. + +##### PUT example: + +In this example a MnS Producer requests the creation of a resource using PUT. + +``` +PUT /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF3 HTTP/1.1 +Host: example.org +Content-Type: application/json + +{ +``` + +``` +"id": "XYZF3", +"objectClass": "XyzFunction", +"attributes": { + "attrA": "ghi", + "attrB": 553 +} +} +``` + +When the resource representation provided in the request is invalid the MnS Producer may send the following error response. + +``` +HTTP/1.1 400 Bad Request +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "type": "VALIDATION_ERROR", + "reason": "NEW_OBJECT_REPRESENTATION_INVALID", + "title": "The object cannot be created because its representation is invalid." +} +``` + +The MnS Producer may also choose to provide more details on why the resource representation is invalid. For example, when the attribute name "attrB" is invalid, the MnS Producer may return the following error response. + +``` +HTTP/1.1 400 Bad Request +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "type": "VALIDATION_ERROR", + "reason": "NEW_ATTRIBUTE_NAME_INVALID", + "title": "The object representation is invalid because an attribute name is invalid.", + "badAttributes": ["#/attributes/attrB"] +} +``` + +It is possible that the request fails for multiple reasons. For example, the object representation might be invalid, and the "id" of the resource requested to be created does already exist. + +``` +HTTP/1.1 207 Multi-Status +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "status": 400, + "type": "VALIDATION_ERROR", + "reason": "NEW_OBJECT_REPRESENTATION_INVALID", + "title": "The object cannot be created because its representation is invalid.", + "otherProblems": [ + { + "status": 422, + "type": "REQUEST OBJECTS MISMATCH", + "reason": "NEW OBJECTS ID EXISTS", + "title": "The object cannot be created because the object id exists already." + } + ] +} +``` + +##### DELETE example: + +In this example a MnS Producer requests the deletion of a resource using DELETE. + +``` +DELETE /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF3 HTTP/1.1 +Host: example.org +``` + +When the object to be deleted does not exist the MnS Producer may send + +``` +HTTP/1.1 404 Not Found +Date: Tue, 06 Aug 2019 16:50:26 GMT +``` + +When the object does exist but cannot be deleted, because it is not a leaf, the error response may be as follows. + +``` +HTTP/1.1 422 Unprocessable Content +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json +``` + +``` +{ + "type": "REQUEST_OBJECTS_MISMATCH", + "reason": "OBJECT NOT A LEAF", + "title": "The object cannot be deleted because it is not a leaf.", +} +``` + +The MnS Producer can also return multiple reasons why a request fails. For example, when the object requested to be deleted is not a leaf, and could not be deleted even if it were a leaf due to cardinality constraints, the MnS Producer may return the following. + +``` +HTTP/1.1 422 Unprocessable Content +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "status": 422, + "type": "REQUEST_OBJECTS_MISMATCH", + "reason": "OBJECT NOT A LEAF", + "title": "The object cannot be deleted because it is not a leaf.", + "otherProblems": [ + { + "status": 422, + "type": "REQUEST_OBJECTS_MISMATCH", + "reason": "OBJECTS_CARDINALITY_INVALID", + "title": "The object cannot be created because of cardinality constraints." + } + ] +} +``` + +In the previous example all problems have the same error code. For that reason the error codes can be omitted in the response body. + +``` +HTTP/1.1 422 Unprocessable Content +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "type": "REQUEST_OBJECTS_MISMATCH", + "reason": "OBJECT NOT A LEAF", + "title": "The object cannot be deleted because it is not a leaf.", + "otherProblems": [ + { + "type": "REQUEST_OBJECTS_MISMATCH", + "reason": "OBJECTS_CARDINALITY_INVALID", + "title": "The object cannot be created because of cardinality constraints." + } + ] +} +``` + +##### 3GPP JSON Patch example: + +Assume the following patch is applied to an object tree, that has one "SubNetwork" instance only. The first operation requests to create a "ManagedElement". This operation is successful. The second operation requests to create a "HuhuFunction" object under the new object. The "HuhuFunction" is not known to the MnS Producer. This operation fails. The third operation fails as well, since it requests to create a new object under an object that does not exist. + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/3gpp-json-patch+json + +[ + { + "op": "add", + "path": "/ManagedElement=ME1", + "value": { + "id": "ME3", + "objectClass": "ManagedElement", + "attributes": { + "userLabel": " Berlin NW 3", + "vendorName": "Company XY", + "location": "Spandau" + } + } + }, + { + "op": "add", + "path": "/ManagedElement=ME1/HuhuFunction=HF1", + "value": { + "id": "HF1", + "objectClass": "HuhuFunction", + "attributes": { + "userLabel": " HF1", + "vendorName": "Company XY", + "location": "Spandau" + } + } + }, + { + "op": "add", + "path": "/SubNetwork=SN1/ManagedElement=ME1/NonExistentObject=NE1", + "value": { + "id": "NE1", + "objectClass": "NonExistentObject", + "attributes": { + "userLabel": " NE1", + "vendorName": "Company XY", + "location": "Spandau" + } + } + } +] +``` + +``` + + "op": "add", + "path": "/ManagedElement=ME1/HuhuFunction=HUHUF1", + "value": { + "id": "XYZF1", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "xyz", + "attrB": 771 + } + } + }, + { + "op": "add", + "path": "/ManagedElement=ME3/XyzFunction=XYZF1", + "value": { + "id": "XYZF2", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "abc", + "attrB": 772 + } + } + } +] + +``` + +The error response may look like: + +``` + +HTTP/1.1 207 Multi-Status +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "status": 400, + "type": "VALIDATION_ERROR", + "reason": "NEW_OBJECT_CLASS_NAME_INVALID", + "title": "The class of the new object to be created is invalid.", + "badOp": "/1", + "otherProblems": [ + { + "status": 422, + "type": "REQUEST_OBJECTS_MISMATCH", + "reason": "NEW_OBJECTS_PARENT_NOT_FOUND", + "title": "The parent object of the new object to be created does not exist.", + "badOp": "/2" + } + ] +} + +``` + +##### 3GPP JSON Merge Patch example: + +Assume the "ManagedElement" with the identifier "ME3" does not exist. Then the following message requests to create two new objects under a non-existent object. This request cannot be satisfied. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/3gpp-merge-patch+json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME3", + "XyzFunction": [ + { + "id": "XYZF1", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "xyz", + "attrB": 771 + } + } + ], + { + "id": "XYZF2", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "abc", + +``` + +``` + + "attrB": 772 + } + } + ] +} +] +} +} + +``` + +The error message may look like: + +``` + +HTTP/1.1 422 Unprocessable Content +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "type": "REQUEST_OBJECTS_MISMATCH", + "reason": "NEW_OBJECT_PARENT_NOT_FOUND", + "title": "The object, below which new objects are requested to be created, does not exist.", + "badObjects": [ + "/ManagedElement=ME3/XyzFunction=XYZF1", + "/ManagedElement=ME3/XyzFunction=XYZF2" + ] +} + +``` + +### 6.6.6 Error reasons for application layer errors + +Error reasons for the error type "APPLICATION\_LAYER\_ERROR" are very dependent on the specific application. Therefore, it is almost impossible to define application layer error reasons that are applicable to more than one application. + +This specification defines the following values for the "reason" property: + +- RESOURCE\_LOCKED (related type: RETRIEVAL\_NOT\_ALLOWED ,403 Forbidden): The resource was locked by administrative action and cannot be accessed. +- SERVICE\_LOCKED (HTTP error code: 503 Service Unavailable): The MnS Producer has been locked by administrative action and is currently unable to handle the request. This condition may occur, for example, due to scheduled maintenance. The "reason" property shall be absent. + +##### Examples: + +In the following example a MnS Consumer requests the creation of a "PerfMetricJob" instance indicating that "metric1" and "metric2" shall be collected for "obj1" and "obj2" with a granularity period of 5min. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/3gpp-json-patch+json + +[ +{ + "op": "add", + "path": "/PerfMetricJob=PMJ1", + "value": { + "PerfMetricJob": [ + { + "id": "PMJ1", + "objectClass": "PerfMetricJob", + "objectInstance": "SubNetwork=SN1,PerfMetricJob=PMJ1", + "attributes": { + "granularityPeriod": "5", + "perfMetrics": [ + "metric1", + "metric2" + ], + "objectInstances": [ + "obj1", + "obj2" + ] + } + } + ] + } +} +] + +``` + +``` +} +] +``` + +When the requested granularity period is not supported, the "PerfMetricJob" instance is not created. The MnS Producer might answer with the following error response. + +``` +HTTP/1.1 400 Bad Request +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.error+json + +{ + "type": "APPLICATION LAYER ERROR", + "reason": "GRANULARITY PERIOD NOT SUPPORTED", + "title": "The requested granularity period for metric collection is not supported." +} +``` + +### 6.6.7 Security considerations + +When the MnS Consumer is not trustworthy or the MnS Producer does not want to disclose error details, just the "type" property may be included in the error response. The response body may be omitted also completely, and just the error status code be returned in the response status line. + +## 6.7 Design pattern for conditional data node selection + +Scoping with the query parameters "scopeType" and "scopeLevel", and filtering with the query parameter "filter" allows for conditional object selection. The query parameters "attributes" and "fields" allow for (unconditional) selection of attributes and attribute fields. + +For multi-valued attributes, where the attribute elements itself are big complex data types, it may be desirable to select also attribute elements based on conditions. For example, assume an alarm list object that has a multi-valued attribute containing alarm records. For retrieving only alarm records with a certain perceived severity it needs to be possible to filter on the perceived severity and return only the alarm records matching that filter criteria. But also attributes or attribute fields may need to be selected based on conditions. For example, assume a managed object that can be locked and disabled. When locked or disabled some state attributes are not updated any more and do not reflect the current state. Reading of these state attributes is hence only meaningful when the object is neither locked nor disabled. + +Conditional attribute data node selection is similar to conditional object selection with the "filter" query parameter. Instead of specifying a query parameters for conditional object selection and another parameter for conditional attribute data node selection, these selection mechanisms may be combined into a single query parameter. + +The name of this query parameter is "dataNodeSelector". Jex [21] shall be used for specifying the selection expression. + +# 7 Resource representation formats + +## 7.1 Introduction + +According to clause 4.3 the media type specifies only that JSON is used as resource representation format carried in the HTTP request and HTTP response message bodies. Some resource patterns are quite common and it is desirable to use a common pattern throughout different APIs. This clause identifies some patterns frequently encountered and provides a JSON schema for them. + +## 7.2 Top-level object + +A single JSON object shall be at the top-level of the document carried in the message body of HTTP requests and HTTP responses. + +``` +{"type": "object"} +``` + +Example: + +``` +{} +``` + +Members of the top-level object can be either a data object, a data array or an error object. + +## 7.3 Data objects + +Data objects are carried in HTTP requests and in HTTP responses in case of success. One and only one data object shall be a member of a top-level object. If a data object is present, no error object shall be present. + +``` +{ + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": {} + } + } +} +``` + +Example: + +``` +{ + "data": {} +} +``` + +## 7.4 Data arrays + +Data arrays are carried in HTTP requests and in HTTP responses when data is transferred. One and only one data array shall be a member of a top-level object. If a data array is present, no error object shall be present. + +``` +{ + "type": "object", + "properties": { + "data": { + "type": "array", + "items": {} + } + } +} +``` + +Example JSON instance: + +``` +{ + "data": [] +} +``` + +## 7.5 Error objects + +Error objects are carried in HTTP responses in case of failure. One and only one error object shall be a member of a top-level object. + +``` +{ + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": {} + } + } +} +``` + +Example JSON instance: + +``` +{ + "error": {} +} +``` + +## 7.6 Resource objects + +Resource objects (resources) are representations of managed object instances. They shall be compliant to the following JSON schema when one instance of a class is allowed. + +``` +{ + "type": "object", + "properties": { + "ClassName": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "objectClass": { "type": "string" }, + "objectInstance": { "type": "string" }, + "attributes": { + "type": "object", + "properties": {} + } + }, + "required": ["id"] + } + } +} +``` + +or by the following schema when more than one instance of a class is allowed + +``` +{ + "type": "object", + "properties": { + "ClassName": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "objectClass": { "type": "string" }, + "objectInstance": { "type": "string" }, + "attributes": { + "type": "object", + "properties": {} + } + }, + "required": ["id"] + } + } + } +} +``` + +An object, whose name is equal to the NRM class name, encapsulates the resource representation. + +The "attributes" object contains NRM attributes as properties. In the generic schema above the "attributes" object has no properties. These properties are defined in other specifications. + +Only the "id" is required to be always present. The "href" property with the URI of the resource and the "class" property with the name of the NRM class can be omitted, or not specified at all in concrete JSON schemas for resource representations. + +TS 32.160 [16] specifies the complete mapping of stage 2 NRM definitions to stage 3 JSON schema definitions. + +## 7.7 Resource objects carried in data objects and arrays + +When a resource object is carried in a data object the schema is given by + +``` +{ + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { +``` + +``` + + "ClassName": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "objectClass": { "type": "string" }, + "objectInstance": { "type": "string" }, + "attributes": { + "type": "object", + "properties": {} + } + }, + "required": ["id"] + } + } +} +} +} +} + +``` + +Multiple instance of the same NRM class are supported by a JSON array. + +``` + +{ + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "ClassName": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "objectClass": { "type": "string" }, + "objectInstance": { "type": "string" }, + "attributes": { + "type": "object", + "properties": {} + } + }, + "required": ["id"] + } + }, + } + } + } +} + +``` + +# 8 REST SS specification template + +This clause contains the REST SS specification template. + +# W RESTful HTTP-based solution set + +## W.1 Mapping of operations + +### W.1.1 Introduction + +The IS operations are mapped to SS equivalents according to table W.1.1-1. + +**Table W.1.1-1: Mapping of IS operations to SS equivalents** + +| IS operation | HTTP Method | Resource URI | S | +|--------------|-------------|--------------|---| +| | | | | + +### W.1.2 Operation + +The IS operation parameters are mapped to SS equivalents according to table W.1.2-1 and table W.1.2-2. + +**Table W.1.2-1: Mapping of IS operation input parameters to SS equivalents ()** + +| IS parameter name | SS parameter location | SS parameter name | SS parameter type | S | +|-------------------|-----------------------|-------------------|-------------------|---| +| | | | | | + +**Table W.1.2-2: Mapping of IS operation output parameters to SS equivalents ()** + +| IS parameter name | SS parameter location | SS parameter name | SS parameter type | S | +|-------------------|-----------------------|-------------------|-------------------|---| +| | | | | | + +### W.1.3 Operation + +*Same as for .* + +## W.2 Mapping of notifications + +### W.2.1 Introduction + +The IS notifications are mapped to SS equivalents according to table W.2.1-1. + +**Table W.2.1-1: Mapping of IS operations to SS equivalents** + +| IS notification | HTTP Method | Resource URI | S | +|-----------------|-------------|--------------|---| +| | | | | +| | | | | + +### W.2.2 Notification + +The IS notification parameters are mapped to SS equivalents according to table W.2.2-1. + +**Table W.2.2-1: Mapping of IS notification parameters to SS equivalents** + +| IS parameter name | SS parameter location | SS parameter name | SS parameter type | S | +|-------------------|-----------------------|-------------------|-------------------|---| +| | | | | | + +### W.2.3 Notification + +*Same as for .* + +## W.3 Usage of HTTP + +## W.4 Resources + +### W.4.1 Resource structure + +#### W.4.1.1 Resource structure on the MnS producer + +Figure W.4.1.1-1 shows the resource structure of the MnS on the MnS producer. + +
+ +**Figure W.4.1.1-1: Resource URI structure of the MnS on the MnS producer** + +Table W.4.1.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table W.4.1.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|---------------|--------------|-------------|-------------| +| | | | | + +#### W.4.1.2 Resource structure on the MnS consumer + +Figure W.4.1.2-1 shows the resource structure of the MnS on the MnS consumer. + +
+ +**Figure W.4.1.2-1: Resource URI structure of the MnS on the MnS consumer** + +Table W.4.1.2-1 provides an overview of the resources and applicable HTTP methods. + +**Table W.4.1.2-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|---------------|--------------|-------------|-------------| +| | | | | + +### W.4.2 Resource definitions + +#### W.4.2.1 Resource + +##### W.4.2.1.1 Description + +*Description of the resource.* + +##### W.4.2.1.2 URI + +Resource URI: + +The resource URI variables are defined in table W.4.2.1.2-1. + +**Table W.4.2.1.2-1: URI variables** + +| Name | Definition | +|------|------------| +| | | + +##### W.4.2.1.3 HTTP methods + +###### W.4.2.1.3.1 + +This method shall support the URI query parameters specified in table W.2.1.3.1-1. + +**Table W.2.1.3.1-1: URI query parameters supported by the on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table W.2.1.3.1-2 and the response data structures and response codes specified in table W.2.1.3.1-3. + +**Table W.2.1.3.1-2: Data structures supported by the request body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| | | | | + +**Table W.2.1.3.1-3: Data structures supported by the response body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|----------|--------------------|-----------------------|--------------------| +| | | | | | + +###### W.4.2.1.3.2 + +*Same as for .* + +#### W.4.2.2 Resource + +*Same as for .* + +## W.5 Data type definitions + +### W.5.1 General + +This clause defines the data types used by the MnS. Table W.4.1-1 specifies the data types defined in the present document and table W.4.1-2 the data types imported + +**Table W.4.1-1: Data types defined in the present document** + +| Data type | Reference | Description | +|------------------|------------------|--------------------| +| | | | + +**Table W.4.1-2: Data types imported** + +| Data type | Reference | Description | +|------------------|------------------|--------------------| +| | | | + +### W.5.2 Structured data types + +#### W.5.2.1 Type + +**Table W.4.2.1-1: Definition of type ** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------|----------|--------------------|--------------------| +| | | | | | + +#### W.5.2.2 Type + +*Same as for .* + +### W.5.3 Simple data types and enumerations + +#### W.5.3.1 General + +This clause defines simple data types and enumerations that are used by the data structures defined in the previous clauses. + +#### W.5.3.2 Simple data types + +**Table W.5.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|------------------|------------------------|--------------------| +| | | | + +#### W.5.3.3 Enumeration + +**Table W.5.3.3-1: Enumeration < EnumType1>** + +| Enumeration value | Description | +|-------------------|-------------| +| | | + +#### W.5.3.4 Enumeration + +# Annex A (normative) + +## OpenAPI definition + +## A.1 Introduction + +This clause contains the OpenAPI definition of the MnS in YAML format. + +## A.2 OpenAPI document ".yaml" + +*OpenAPI definition* + +# Annex A (informative): Examples + +## A.1 Example data model + +The following JSON instance document is used for the examples in this clause. + +``` +{ + "SubNetwork": [ + { + "id": "SN1", + "objectClass": "SubNetwork", + "objectInstance": "DC=example.org,SubNetwork=SN1", + "attributes": { + "userLabel": "Berlin NW", + "userDefinedNetworkType": "5G", + "plmnId": { + "mcc": 456, + "mnc": 789 + } + }, + }, + "ManagedElement": [ + { + "id": "ME1", + "objectClass": "ManagedElement", + "objectInstance": "DC=example.org,SubNetwork=SN1,\ + ManagedElement=ME1", + "attributes": { + "userLabel": "Berlin NW 1", + "vendorName": "Company XY", + "location": "TV Tower" + }, + "XyzFunction": [ + { + "id": "XYZF1", + "objectClass": "XyzFunction", + "objectInstance": "DC=example.org,SubNetwork=SN1,\ + ManagedElement=ME1,XyzFunction=XYZF1", + "attributes": { + "attrA": "xyz", + "attrB": 551 + } + }, + { + "id": "XYZF2", + "objectClass": "XyzFunction", + "objectInstance": "DC=example.org,SubNetwork=SN1,\ + ManagedElement=ME1,XyzFunction=XYZF2", + "attributes": { + "attrA": "abc", + "attrB": 552 + } + } + ] + }, + { + "id": "ME2", + "objectClass": "ManagedElement", + "objectInstance": "DC=example.org,SubNetwork=SN1,ManagedElement=ME2", + "attributes": { + "userLabel": "Berlin NW 2", + "vendorName": "Company XY", + "location": "Grunewald" + } + } + ], + "PerfMetricJob": [ + { + "id": "PMJ1", + "objectClass": "PerfMetricJob", + "objectInstance": "DC=example.org,SubNetwork=SN1,PerfMetricJob=PMJ1", + } + ] + ] +} +``` + +``` + + "attributes": { + "granularityPeriod": "5", + "perfMetrics": [ + "Metric1", + "Metric2" + ], + "objectInstances": [ + "Obj1", + "Obj2" + ] + } + ], + "ThresholdMonitor": [ + { + "id": "TM1", + "objectClass": "ThresholdMonitor", + "objectInstance": "DC=example.org,SubNetwork=SN1,ThresholdMonitor=TM1", + "attributes": { + "metric": "Metric1", + "thresholdLevels": [ + { + "level": "1", + "thresholdValue": 10 + }, + { + "level": "2", + "thresholdValue": 20 + }, + { + "level": "3", + "thresholdValue": 30 + } + ] + } + } + ] +] +} + +``` + +The corresponding JSON schema is + +``` + +{ + "SubNetwork": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "objectClass": { + "type": "string" + }, + "objectInstance": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "userLabel": { + "type": "string" + }, + "userDefinedNetworkType": { + "type": "string" + }, + "plmnId": { + "type": "object", + "properties": { + "mcc": { + "type": "integer" + }, + "mnc": { + "type": "integer" + } + } + } + } + } + } + } + } +} + +``` + +``` + + } + } + }, + "ManagedElement": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "objectClass": { + "type": "string" + }, + "objectInstance": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "userLabel": { + "type": "string" + }, + "vendorName": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "XyzFunction": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "objectClass": { + "type": "string" + }, + "objectInstance": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "attributeA": { + "type": "string" + }, + "attributeB": { + "type": "integer" + } + } + }, + "required": ["id"] + } + } + }, + "required": ["id"] + } + }, + "PerfMetricJob": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "objectClass": { + "type": "string" + }, + "objectInstance": { + "type": "string" + }, + +``` + +``` + + "attributes": { + "type": "object", + "properties": { + "granularityPeriod": { + "type": "integerstring" + }, + "perfMetrics": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "objectInstances": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": ["id"] + } + } + }, + "ThresholdMonitor": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "objectClass": { + "type": "string" + }, + "objectInstance": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "thresholdLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "level": { + "type": "string" + }, + "thresholdValue": { + "type": "integer" + } + } + } + } + } + } + }, + "required": ["id"] + } + }, + "required": ["id"] +} + } + } + } +} + +``` + +The corresponding XML instance document is provided below as well. It can be helpful when evaluating XPath expressions. + +``` + + + + + SN1 + SubNetwork + DC=example.org,SubNetwork=SN1 + +``` + +``` + + Berlin NW + 5G + + 456 + 789 + + + + ME1 + ManagedElement + DC=example.org,SubNetwork=SN1,ManagedElement=ME1 + + Berlin NW 1 + Company XY + TV Tower + + + XYZF1 + XyzFunction + DC=example.org,SubNetwork=SN1,\ + ManagedElement=ME1,XyzFunction=XYZF1 + + xyz + 551 + + + + XYZF2 + XyzFunction + DC=example.org,SubNetwork=SN1,\ + ManagedElement=ME1,XyzFunction=XYZF2 + + abc + 552 + + + + + ME2 + ManagedElement + SubNetwork=SN1,ManagedElement=ME2 + + Berlin NW 2 + Company XY + Grunewald + + + + PMJ1 + PerfMetricJob + SubNetwork=SN1,PerfMetricJob=PMJ1 + + 5 + Metric1 + Metric2 + Obj1 + Obj2 + + + + TM1 + ThresholdMonitor + SubNetwork=SN1,ThresholdMonitor=TM1 + + + 1 + 10 + + + 2 + 20 + + + 3 + 30 + + +``` + +``` + + + +``` + +NOTE: Void + +The following examples do not always follow the URI structure specified in clause 4.4. For simplicity reasons, the path component "{MnSName}/{MnSVersion}" is often omitted. + +Furthermore, the value of query parameters is not always percent-encoded, as defined in clause 2 and 3.4 of RFC 3986 [4], for better readability. + +## A.2 Retrieval of resources + +### A.2.1 Retrieval of a single complete resource with HTTP GET + +To retrieve a complete "XyzFunction" resource the MnS Consumer might send the following request. + +``` +GET /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Accept: application/json +``` + +The response includes a JSON object with the resource representation. + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "XYZF1", + "attributes": { + "attrA": "xyz", + "attrB": 551 + } +} +``` + +The MnS Consumer might request also to return a response constructed according to the flat response construction method. In this case the "Accept" header contains the "application/vnd.3gpp.object-tree-flat+json" media type. + +``` +GET /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Accept: application/vnd.3gpp.object-tree-flat+json +``` + +The response is a JSON array with a single item, which is a JSON object with the resource representation. Note that the resource representation contains the "objectClass" and "objectInstance" in this case. + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.object-tree-flat+json + +[ + { + "id": "XYZF1", + "objectClass": "XyzFunction", + "objectInstance": "DC=example.org,SubNetwork=SN1,ManagedElement=ME1,XyzFunction=XYZF1", + "attributes": { + "attrA": "xyz", + "attrB": 551 + } + } +] +``` + +### A.2.2 Attribute and attribute field selection on a single resource + +To retrieve only the "userLabel" attribute and the "mnc" attribute field of the "plmnId" attribute of the "SubNetwork", the MnS Consumer might send: + +``` +GET /SubNetwork=SN1?attributes=userLabel&fields=/attributes/plmnId/mnc HTTP/1.1 +Host: example.org +Accept: application/json +``` + +Alternatively one might send as well + +``` +GET /SubNetwork=SN1?fields=/attributes/userLabel,/attributes/plmnId/mnc HTTP/1.1 +Host: example.org +Accept: application/json +``` + +The response contains only the selected attribute "userLabel" and the selected attribute field "mnc": + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "attributes": { + "userLabel": "Berlin NW", + "plmnId": { + "mnc": 789 + } + } +} +``` + +In the next example, the MnS Consumer retrieves the "userLabel" and "vendorName" of the "ManagedElement" whose "id" is equal to "ME1": + +``` +GET /SubNetwork=SN1/ManagedElement=ME1?attributes=userLabel, vendorName HTTP/1.1 +Host: example.org +Accept: application/json +``` + +The MnS Producer responds as follows: + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "ME1", + "attributes": { + "userLabel": "Berlin NW 1", + "vendorName": "Company XY" + } +} +``` + +The following request selects all attributes: + +``` +GET /SubNetwork=SN1/ManagedElement=ME1?fields=/attributes HTTP/1.1 +Host: example.org +Accept: application/json +``` + +It is thus identical to: + +``` +GET /SubNetwork=SN1/ManagedElement=ME1 HTTP/1.1 +Host: example.org +Accept: application/json +``` + +Both requests return the complete resource representation with all attributes: + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +``` + +``` +Content-Type: application/json + +{ + "id": "ME1", + "attributes": { + "userLabel": "Berlin NW 1", + "vendorName": "Company XY", + "location": "TV Tower" + } +} +``` + +The following request returns the first item of the "perfMetrics" attribute, which is of type array: + +``` +GET /SubNetwork=SN1/ManagedElement=ME1/PerfMetricJob=PMJ1?fields=attributes/perfMetrics/0 HTTP/1.1 +Host: example.org +Accept: application/json +``` + +Note indices start with "0" in JSON Pointer. The response looks like: + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "PMJ1", + "attributes": { + "perfMetrics": [ + "Metric1" + ] + } +} +``` + +### A.2.3 Retrieval of multiple complete resources using scoping and filtering + +The following example selects the "SubNetwork" as base object at scope level "0" and all objects at scope level "1": + +``` +GET /SubNetwork=SN1?scopeType=BASE_SUBTREE&scopeLevel=1 HTTP/1.1 +Host: example.org +Accept: application/json +``` + +The base object and all objects at scope level "1", irrespective of their object class, are included in the response. The acceptable response media type specified by the "Accept" header field is "application/json", which indicates to the MnS producer to use the hierarchical response construction method + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "attributes": { + "userLabel": "Berlin NW", + "userDefinedNetworkType": "5G", + "plmnId": { + "mcc": 456, + "mnc": 789 + } + }, + "ManagedElement": [ + { + "id": "ME1", + "attributes": { + "userLabel": "Berlin NW 1", + "vendorName": "Company XY", + "location": "TV Tower" + } + }, + { + "id": "ME2", + "attributes": { + "userLabel": "Berlin NW 2", + } + } + ] +} +``` + +``` + + "vendorName": "Company XY", + "location": "Grunewald" + } + } + ], + "PerfMetricJob": [ + { + "id": "PMJ1", + "attributes": { + "granularityPeriod": 5, + "perfMetrics": [ + "Metric1", + "Metric2" + ], + "objectInstances": [ + "Obj1", + "Obj2" + ] + } + } + ], + "ThresholdMonitor": [ + { + "id": "TM1", + "attributes": { + "metric": "Metric1", + "thresholdLevels": [ + { + "level": "1", + "thresholdValue": 10 + }, + { + "level": "2", + "thresholdValue": 20 + }, + { + "level": "3", + "thresholdValue": 30 + } + ] + } + } + ] +} + +``` + +The MnS Consumer can request also to return a response constructed according to the flat response construction method. In this case the "Accept" header contains the "application/vnd.3gpp.object-tree-flat+json" media type. + +``` + +GET /SubNetwork=SN1?scopeType=BASE_SUBTREE&scopeLevel=1 HTTP/1.1 +Host: example.org +Accept: application/vnd.3gpp.object-tree-flat+json + +``` + +The response looks like: + +``` + +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/vnd.3gpp.object-tree-flat+json + +[ + { + "id": "SN1", + "objectClass": "SubNetwork", + "objectInstance": "DC=example.org,SubNetwork=SN1", + "attributes": { + "userLabel": "Berlin NW", + "userDefinedNetworkType": "5G", + "plmnId": { + "mcc": 456, + "mnc": 789 + } + } + }, + { + "id": "ME1", + "objectClass": "ManagedElement", + "objectInstance": "SubNetwork=SN1,ManagedElement=ME1", + "attributes": { + +``` + +``` + + "userLabel": "Berlin NW 1", + "vendorName": "Company XY", + "location": "TV Tower" + } +}, +{ + "id": "ME2", + "objectClass": "ManagedElement", + "objectInstance": "DC=example.org,SubNetwork=SN1,ManagedElement=ME2", + "attributes": { + "userLabel": "Berlin NW 2", + "vendorName": "Company XY", + "location": "Grunewald" + } +}, +{ + "id": "PMJ1", + "objectClass": "PerfMetricJob", + "objectInstance": "DC=example.org,SubNetwork=SN1,PerfMetricJob=PMJ1", + "attributes": { + "granularityPeriod": "5", + "perfMetrics": [ + "Metric1", + "Metric2" + ], + "objectInstances": [ + "Obj1", + "Obj2" + ] + } +}, +{ + "id": "TM1", + "objectClass": "ThresholdMonitor", + "objectInstance": "DC=example.org,SubNetwork=SN1,ThresholdMonitor=TM1", + "attributes": { + "metric": "Metric1", + "thresholdLevels": [ + { + "level": "1", + "thresholdValue": 10 + }, + { + "level": "2", + "thresholdValue": 20 + }, + { + "level": "3", + "thresholdValue": 30 + } + ] + } +} +] + +``` + +The "objectInstance" of each returned object is present in the response, as required in clause 6.1.4. + +When only objects at scope level "1" are requested to be returned, the request looks like: + +``` + +GET /SubNetwork=SN1?scopeType=BASE_NTH_LEVEL&scopeLevel=1 HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +The response does not include the attributes of "SubNetwork" any more, only its "id" is included: + +``` + +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "attributes": { + "userLabel": "Berlin NW 1", + +``` + +``` + + "vendorName": "Company XY", + "location": "TV Tower" + } +}, +{ + "id": "ME2", + "attributes": { + "userLabel": "Berlin NW 2", + "vendorName": "Company XY", + "location": "Grunewald" + } +} +], +"PerfMetricJob": [ +{ + "id": "PMJ1", + "attributes": { + "granularityPeriod": 5, + "perfMetrics": [ + "Metric1", + "Metric2" + ], + "objectInstances": [ + "Obj1", + "Obj2" + ] + } +} +], +"ThresholdMonitor": [ +{ + "id": "TM1", + "attributes": { + "metric": "Metric1", + "thresholdLevels": [ + { + "level": "1", + "thresholdValue": 10 + }, + { + "level": "2", + "thresholdValue": 20 + }, + { + "level": "3", + "thresholdValue": 30 + } + ] + } +} +] +] +} + +``` + +Similarly, for reading all objects on scope level "2", the MnS Consumer may send: + +``` + +GET /SubNetwork=SN1?scopeType=BASE_NTH_LEVEL&scopeLevel=2 HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +When using the hierarchical response construction method, the response includes the complete representations of the two "XyzFunction" objects. The "SubNetwork" and "ManagedElement" are present with their "id" only; they provide the containment nodes for the "XyzFunction" objects. + +``` + +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "XyzFunction": [ + { + "id": "XYZF1", + "attributes": { + "attrA": "xyz", + +``` + +``` + + "attrB": 551 + } + }, + { + "id": "XYZF2", + "attributes": { + "attrA": "abc", + "attrB": 552 + } + } + ] +} + +``` + +The "PerfMetricJob" and "ThresholdMonitor" are not included altogether, not even with the "id" only. This is because these nodes do not represent necessary path components to the scoped objects on the second level. + +When using the flat response construction method, the response includes only the two "XyzFunction" objects without containment nodes. + +``` + +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json +[ + { + "id": "XYZF1", + "objectClass": "XyzFunction", + "objectInstance": "DC=example.org,SubNetwork=SN1,ManagedElement=ME1,XyzFunction=XYZF1", + "attributes": { + "attrA": "xyz", + "attrB": 551 + } + }, + { + "id": "XYZF2", + "objectClass": "XyzFunction", + "objectInstance": "DC=example.org,SubNetwork=SN1,ManagedElement=ME1,XyzFunction=XYZF2", + "attributes": { + "attrA": "abc", + "attrB": 552 + } + } +] + +``` + +The following example selects all objects of any class on scope level "1" that have a "location" attribute whose value is equal to "Grunewald": + +``` + +GET /SubNetwork=SN1?\ + scopeType=BASE_NTH_LEVEL&scopeLevel=1&\ + filter=/*/*/attributes[location="Grunewald"] HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +The response includes one "ManagedElement" object only: + +``` + +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME2", + "attributes": { + "userLabel": "Berlin NW 2", + "vendorName": "Company XY", + "location": "Grunewald" + } + } + ] +} + +``` + +The input document to the XPath expression is a document whose root node is the object identified by the path component of the target URI and that includes the object representations of the scoped objects. In this example the root node is the "SubNetwork", but it is not scoped and hence included in the input document with its "id" only, i.e. without the "attributes" node. The input document includes furthermore all scoped objects on level "1" with their complete representations (without name-contained objects). These are the two "ManagedElement" objects, the "PerfMetricJob" object, and the "ThresholdMonitor" object. + +``` +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "attributes": { + "userLabel": "Berlin NW 1", + "vendorName": "Company XY", + "location": "TV Tower" + } + }, + { + "id": "ME2", + "attributes": { + "userLabel": "Berlin NW 2", + "vendorName": "Company XY", + "location": "Grunewald" + } + } + ], + "PerfMetricJob": [ + { + "id": "PMJ1", + "attributes": { + "granularityPeriod": 5, + "perfMetrics": [ + "Metric1", + "Metric2" + ], + "objectInstances": [ + "Obj1", + "Obj2" + ] + } + } + ], + "ThresholdMonitor": [ + { + "id": "TM1", + "attributes": { + "metric": "Metric1", + "thresholdLevels": [ + { + "level": "1", + "thresholdValue": 10 + }, + { + "level": "2", + "thresholdValue": 20 + }, + { + "level": "3", + "thresholdValue": 30 + } + ] + } + } + ] +} +``` + +An implementation may be based on available XPath tools. In that case the JSON document may have to be converted to a XML document. Note that a valid XML document has one and only one root element. For that reason the "SubNetwork" element needs to be added as root element.. + +``` + + SN1 + + ME1 + +``` + +``` + + Berlin NW 1 + Company XY + TV Tower + + + + ME2 + + Berlin NW 2 + Company XY + Grunewald + + + + PMJ1 + + 5 + Metric1 + Metric2 + Obj1 + Obj2 + + + + TM1 + + + 1 + 10 + + + 2 + 20 + + + 3 + 30 + + + + + +``` + +In this example the complete "ManagedElement" object is the result of applying the XPath expression: + +``` + + + ME2 + + Berlin NW 2 + Company XY + Grunewald + + + +``` + +XPath predicates allow to specify also ranges. The following example selects objects on scope level "2" that have an attribute with name "attrB" whose value is equal to or greater than 552 and less than 562. + +``` + +GET /SubNetwork=SN1? \ + scopeType=BASE NTH LEVEL&scopeLevel=2&\ + filter=/*/*/*/@attributes[@attrB>=552 and @attrB<562] HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +The response includes one "XyzFunction" object only: + +``` + +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "XyzFunction": [ + { + "id": "XYZF2", + "attributes": { + +``` + +``` + + "attrA": "abc", + "attrB": 552 + } + ] + ] +] +} + +``` + +An identical response is returned when using the following requests: + +``` + +GET /SubNetwork=SN1? + scopeType=BASE_ALL&\ + filter=//*[attributes[attrB]>=552 and attrB<562]] HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +or + +``` + +GET /SubNetwork=SN1? + scopeType=BASE_SUBTREE&scopeLevel=2&\ + filter=//*[attributes[attrB]>=552 and attrB<562]] HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +or + +``` + +GET /SubNetwork=SN1? + scopeType=BASE_ALL&\ + filter=//XyzFunction[attributes[attrB]>=552 and attrB<562]] HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +It is possible to combine scoping and filtering with attribute and attribute field selection. The following example returns the containment tree, starting with the "SubNetwork" identified by the target URI. + +``` + +GET /SubNetwork=SN1?scopeType=BASE_ALL&attributes= HTTP/1.1 +Host: example.org +Accept: application/json +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "XyzFunction": [ + { + "id": "XYZF1" + }, + { + "id": "XYZF2" + } + ] + }, + { + "id": "ME2" + } + ], + "PerfMetricJob": [ + { + "id": "PMJ1" + } + ], + "ThresholdMonitor": [ + { + "id": "TM1" + } + ] +} + +``` + +The next example scopes the same subtree as in the previous example and requests to return only "vendorName" attributes instead of no attributes at all. + +``` +GET /ProvMnS/v1700?\ + scopeType=BASE_ALL&\ + attributes=vendorName HTTP/1.1 +Host: example.org +Accept: application/json +``` + +This results, according to clause 6.2.3, in removing from the response all scoped resources that do not have a "vendorName" attribute. + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "attributes": { + "vendorName": "Company XY" + } + }, + { + "id": "ME2", + "attributes": { + "vendorName": "Company XY" + } + } + ] +} +``` + +If the retrieval request identifies resources that do not exist, such as in + +``` +GET /ProvMnS/v1700?scopeType=BASE_NTH_LEVEL&scopeLevel=3 HTTP/1.1 +Host: example.org +Accept: application/json +``` + +The MnS producer returns a "204 No Content" response. + +``` +HTTP/1.1 204 No Content +Date: Tue, 06 Aug 2019 16:50:26 GMT +``` + +When the MnS Consumer does not know the root objects of the containment tree and wants to retrieve the complete trees starting with the roots, the target URI needs to identify the NRM root, i.e. the resource above the root objects. According to clause 4.4.2, this resource is identified by the path segment "{MnSName}/{MnSVersion}", for example "/ProvMnS/v1700". In the following example, the "attributes" query parameter is empty and only the name-containment hierarchy (without attributes) is returned. + +``` +GET /ProvMnS/v1700?scopeType=BASE_ALL&attributes= HTTP/1.1 +Host: example.org +Accept: application/json +``` + +The response is illustrated below. + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "SubNetwork": [ + { + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "XyzFunction": [ + { + "id": "XYZF1" + }, + { + "id": "XYZF2" + } + ] + } + ] + }, + ] +} +``` + +``` + + { + "id": "ME2" + } + ], + "PerfMetricJob": [ + { + "id": "PMJ1" + } + ], + "ThresholdMonitor": [ + { + "id": "TM1" + } + ] +} +] +} + +``` + +Multiple root resources can be returned as well. For example, assume a NRM with three "SubNetwork" root resources, then the response may look like: + +``` + +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "SubNetwork": [ + { + "id": "SN1", + ... + }, + { + "id": "SN2", + ... + }, + { + "id": "SN3", + ... + } + ] +} + +``` + +Note that when the target URI identifies the NRM root, then the name of the document (root) element, to which an XPath expression is applied, is "nrmRoot". The first step of the location path of an XPath expression is hence "/nrmRoot". For example, the following HTTP GET request returns the "SubNetwork" with the identifier "SN1". + +``` + +GET /ProvMnS/v1700? \ + scopeType=BASE_ALL&\ + filter=/nrmRoot/SubNetwork[id="SN1"]/attributes HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +Note the presence of the location step "/attributes". This step is necessary to select only the "attributes" container and hence only the SubNetwork" with the identifier "SN1" without any name-contained objects. + +``` + +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "SubNetwork": [ + { + "id": "SN1", + "objectClass": "SubNetwork", + "objectInstance": "DC=example.org,SubNetwork=SN1", + "attributes": { + "userLabel": "Berlin NW", + "userDefinedNetworkType": "5G", + "plmnId": { + "mcc": 456, + "mnc": 789 + } + } + } + ] +} + +``` + +``` + +] +} + +``` + +Without the location step "/attributes" the complete subtree would be returned. + +In all examples above query parameter values are not percent-encoded for better readability. For example, the value of the filter query parameter in the following request + +``` + +GET /ProvMnS/v1700? \ + scopeType=BASE ALL&\ + filter=/nrmRoot/SubNetwork[id="SN1"]/attributes HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +needs to be percent-encoded. + +``` + +GET /ProvMnS/v1700? \ + scopeType=BASE ALL&\ + filter=%2FnmRoot%2FSubNetwork%5Bid%3D%22SN1%22%5D%2Fattributes HTTP/1.1 +Host: example.org +Accept: application/json + +``` + +### A.2.4 Large queries + +The following example shows how to construct a GET request using method override. + +``` + +POST /ProvMnS/v1700 HTTP/1.1 +Host: example.org +X-HTTP-Method-Override: GET +Content-Type: application/x-www-form-urlencoded +Accept: application/json + +scopeType=BASE ALL&filter=%2FnmRoot%2FSubNetwork%5Bid%3D%22SN1%22%5D%2Fattributes + +``` + +## A.3 Creation of resources + +### A.3.1 Creation of a resource with HTTP PUT + +In this example a new "XyzFunction" resource is created. The target URI specifies the location of the new resource. The object class name of the resource to be created is present in the request. The "id" of the new resource is "XYZF3" and created by the MnS Consumer. The "id" contained in the resource representation carried in the request message body and the "id" in the target URI are identical. + +``` + +PUT /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF3 HTTP/1.1 +Host: example.org +Content-Type: application/json + +{ + "id": "XYZF3", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "ghi", + "attrB": 553 + } +} + +``` + +If the HTTP PUT request succeeds, the status code "201 Created" is returned in the response status line. The location header is present, its value is the URI of the created resource. The response message body contains the complete representation of the new resource. The name of the object class may or may not be present in the response. + +``` + +HTTP/1.1 201 Created +Date: Tue, 06 Aug 2019 16:50:26 GMT +Location: http://example.org/SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF3 +Content-Type: application/json + +``` + +``` +{ + "id": "XYZF3", + "attributes": { + "attrA": "ghi", + "attrB": 553 + } +} +``` + +In this example, the MnS Producer creates the object with the attribute name/value pairs as provided in the request. For that reason, "204 No Content" may be returned in the status line instead of "201 Created". The response message body is absent in this case. + +``` +HTTP/1.1 204 No Content +Date: Tue, 06 Aug 2019 16:50:26 GMT +Location: http://example.org/SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF3 +Content-Type: application/json +``` + +### A.3.2 Creation of a resource with HTTP POST + +When creating a new resource with POST the target URI identifies the parent resource of the new resource to be created. The identifier of the new resource is created by the MnS Producer, hence the "id" is equal to "null" in the POST request. If the "id" carries a value, then the MnS Producer may consider that value as a non-binding recommendation by the MnS Consumer. The request message body includes the object class name of the resource to be created. + +``` +POST /SubNetwork=SN1/ManagedElement=ME1 HTTP/1.1 +Host: example.org +Content-Type: application/json + +{ + "id": null, + "objectClass": "XyzFunction", + "attributes": { + "attrA": "ghi", + "attrB": 553 + } +} +``` + +For the response body the same provisions as for resource creation with HTTP PUT apply. + +``` +HTTP/1.1 201 Created +Date: Tue, 06 Aug 2019 16:50:26 GMT +Location: http://example.org/ SubNetwork=SN1/ManagedElement=ME1/XyzFunction=123e4567-e89b +Content-Type: application/json + +{ + "id": "123e4567-e89b", + "attributes": { + "attrA": "ghi", + "attrB": 553 + } +} +``` + +When creating a root resource of the model, the path component of the request URI refers to the parent resource of the top level managed object instances as defined in clause 4.4.4. + +``` +POST /ProvMnS/v1700 HTTP/1.1 +Host: example.org +Content-Type: application/json + +{ + "id": null, + "objectClass": "SubNetwork", + "attributes": { + "userLabel": "Berlin NW", + "userDefinedNetworkType": "5G", + "plmnId": { + "mcc": 456, +``` + +``` + + "mnc": 789 + } +} +} + +``` + +### A.3.3 Creation of multiple resources with 3GPP JSON Merge Patch + +One or more resources can be created with a single 3GPP JSON Merge Patch request. The following example shows the creation of a complete subtree for a new "ManagedElement" below "SubNetwork". + +The target URI has been chosen to identify the first common ancestor of the resources to be created. In this case, it is the parent of the base object of the tree to be created. The "objectClass" property is present for the resources to be created. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.merge-patch+json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME3", + "objectClass": "ManagedElement", + "attributes": { + "userLabel": " Berlin NW 3", + "vendorName": "Company XY", + "location": "Spandau" + }, + "XyzFunction": [ + { + "id": "XYZF1", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "xyz", + "attrB": 771 + } + }, + { + "id": "XYZF2", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "abc", + "attrB": 772 + } + } + ] + } + ] +} + +``` + +The MnS Producer might respond as follows to indicate the PATCH request was successful and the received resource representation was not modified. + +``` + +HTTP/1.1 204 No Content +Date: Tue, 06 Aug 2019 16:50:26 GMT + +``` + +The next example shows how a new "XyzFunction" resource is added to each of the "ManagedElement" resources. + +In this case, the parent of the parent of the "XyzFunction" resources to be created has been chosen as the common ancestor referenced by the target URI. The "objectClass" property is present for the resources to be created. + +The "ManagedElement" resources are present with their "id" only. These resources are required to bridge the containment tree from the "SubNetwork" target resource to the created "XyzFunction" resources. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.merge-patch+json + +``` + +``` +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "XyzFunction": [ + { + "id": "XYZF3", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "def", + "attrB": 553 + } + } + ] + }, + { + "id": "ME2", + "XyzFunction": [ + { + "id": "XYZF1", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "def", + "attrB": 661 + } + } + ] + } + ] +} +``` + +The MnS Producer might respond again as follows to indicate the successful creation of the resources. + +``` +HTTP/1.1 204 No Content +Date: Tue, 06 Aug 2019 16:50:26 GMT +``` + +Assume now that for "XyzFunction" a third attribute "attrC" is defined and that this attribute has a default value of "5". The MnS Producer assigns the default value after reception of the PATCH request and before creating the resource when no value is provided for "attrC" in the request. In this case the response includes the modified resource representations. + +``` +HTTP/1.1 200 OK +Date: Tue, 06 Aug 2019 16:50:26 GMT +Content-Type: application/json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "XyzFunction": [ + { + "id": "XYZF3", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "def", + "attrB": 553, + "attrC": 5 + } + } + ] + }, + { + "id": "ME2", + "XyzFunction": [ + { + "id": "XYZF1", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "def", + "attrB": 661, + "attrC": 5 + } + } + ] + } + ] +} +``` + +``` + + } + } +} +] +} +} + +``` + +### A.3.4 Creation of multiple resources with 3GPP JSON Patch + +One or more resources can be created with a single 3GPP JSON Patch request. The following example shows the creation of a complete subtree for a new network entity represented by a "ManagedElement" resource and two "XyzFunction" resources. The target URI has been chosen to identify the first common ancestor of the resources to be created. The "path" specifies the offset from the target resource to the resource to be created. The "path" has no fragment component. Parent resources are created before child resources following the order of the operations in the patch document. The class name of the object to be created is specified in each patch operation. The "Accept" header specifies responses with hierarchical object tree are acceptable. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "add", + "path": "/ManagedElement=ME3", + "value": { + "id": "ME3", + "objectClass": "ManagedElement", + "attributes": { + "userLabel": " Berlin NW 3", + "vendorName": "Company XY", + "location": "Spandau" + } + } + }, + { + "op": "add", + "path": "/ManagedElement=ME3/XyzFunction=XYZF1", + "value": { + "id": "XYZF1", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "xyz", + "attrB": 771 + } + } + }, + { + "op": "add", + "path": "/ManagedElement=ME3/XyzFunction=XYZF2", + "value": { + "id": "XYZF2", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "abc", + "attrB": 772 + } + } + } +] + +``` + +Note that each resource to be created shall be specified with a dedicated "add" operation. The following patch document is hence invalid as it attempts to create three resources with a single "add" operation. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "add", + +``` + +``` + + "path": "/ManagedElement=ME3", + "value": { + "id": "ME3", + "objectClass": "ManagedElement", + "attributes": { + "userLabel": " Berlin NW 3", + "vendorName": "Company XY", + "location": "Spandau" + }, + "XyzFunction": [ + { + "id": "XYZF1", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "xyz", + "attrB": 771 + } + }, + { + "id": "XYZF2", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "abc", + "attrB": 772 + } + } + ] + } + } +] + +``` + +It is not an error if the target location of an "add" operation as specified by the "path" property does exist. In this case the content of the target location is replaced with the content of the "value" property. For example, in the following example, the first "ManagedElement" resource already exists. The patch document is applied successfully though. The representation of the first "ManagedElement" resource is replaced and the second "ManagedElement" resource is created. + +Note that the attributes "vendorName" and "location" are removed from the representation of the first "ManagedElement" resource. The "userLabel" attribute is updated. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "add", + "path": "/ManagedElement=ME2", + "value": { + "id": "ME2", + "objectClass": "ManagedElement", + "attributes": { + "userLabel": " Berlin NW 4" + } + } + }, + { + "op": "add", + "path": "/ManagedElement=ME3", + "value": { + "id": "ME3", + "objectClass": "ManagedElement", + "attributes": { + "userLabel": " Berlin NW 3", + "vendorName": "Company XY", + "location": "Spandau" + } + } + } +] + +``` + +## A.4 Deletion of resources + +### A.4.1 Deletion of a resource with HTTP DELETE + +The following example deletes an instance of "ManagedElement". The resource to be deleted is identified with the target URI. The request body is absent. + +``` +DELETE /SubNetwork=SN1/ManagedElement=ME2 HTTP/1.1 +Host: example.org +``` + +The MnS Producer might respond as follows. + +``` +HTTP/1.1 204 No Content +Date: Tue, 06 Aug 2019 16:50:26 GMT +``` + +### A.4.2 Deletion of multiple resources with HTTP DELETE + +The deletion of multiple resources with a single HTTP DELETE request is not supported. The following request is hence invalid. + +``` +DELETE /SubNetwork=SN1?scopeType= BASE NTH LEVEL&scopeLevel=2 HTTP/1.1 +Host: example.org +``` + +### A.4.3 Deletion of multiple resources with 3GPP JSON Merge Patch + +One or more descendant resources of the target URI can be deleted with a single 3GPP JSON Merge Patch request. The following example deletes the "ManagedElement" resource with "ME1" including both its "XyzFunction" resources. + +The target URI has been chosen to identify the first common ancestor of the resources to be deleted. The patch document starts with the target resource. All resources of the subtree to be deleted are marked for deletion. + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.merge-patch+json + +{ + "id": "SN1", + "ManagedElement": [ + { + "id": "ME1", + "attributes": null, + "XyzFunction": [ + { + "id": "XYZF1", + "attributes": null + }, + { + "id": "XYZF2", + "attributes": null + } + ] + } + ] +} +``` + +### A.4.4 Deletion of multiple resources with 3GPP JSON Patch + +Multiple resources are deleted with an ordered sequence of "remove" operations. The following example removes a complete subtree for a "ManagedElement". + +The target URI has been chosen to identify the parent resource of the "ManagedElement" resource to be deleted. The "path" specifies the offset to the resources to be deleted. The "path" has no fragment component. + +Child resources are deleted before parent resources, starting with leaf resources. + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "remove", + "path": "/ManagedElement=ME1/XyzFunction=XYZF1" + }, + { + "op": "remove", + "path": "/ManagedElement=ME1/XyzFunction=XYZF2" + }, + { + "op": "remove", + "path": "/ManagedElement=ME1" + } +] +``` + +## A.5 Complete update of a resource + +The following example updates a "XyzFunction" resource. Only the "attrA" attribute is updated with a new value "def". The "attrB" attribute is set to the old value "551", but still the "attrB" attribute needs to be present in the resource representation contained in the request message body. Otherwise "attrB" would be deleted due to the replace semantics of HTTP PUT. + +``` +PUT /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json + +{ + "id": "XYZF1", + "attributes": { + "attrA": "def", + "attrB": 551 + } +} +``` + +When a non leaf resource is updated, contained resources are not included. For example, the following resource representation in the message body updates the "ManagedElement" resource only. It does not delete the contained "XyzFunction" resources. + +``` +PUT /SubNetwork=SN1/ManagedElement=ME1 HTTP/1.1 +Host: example.org +Content-Type: application/json + +{ + "id": "ME1", + "attributes": { + "userLabel": "Berlin New Label", + "vendorName": "Company XY", + "location": "TV Tower" + } +} +``` + +## A.6 Partial update of a resource + +### A.6.1 Partial update of a resource with JSON Merge Patch + +The first example shows how the attribute "attrA" of the "XyzFunction" with the "id" equal to "YXYZF1" is changed from "xyz" to "def" using JSON Merge Patch. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=YXYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/merge-patch+json + +{ + "id": "YXYZF1", + "attributes": { + "attrA": "def" + } +} +``` + +In the second example the "mcc" attribute field of the "plmnId" attribute is updated to "654". The employed patch method is again JSON Merge Patch. + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/merge-patch+json + +{ + "id": "SN1", + "attributes": { + "plmnId": { + "mcc": 654 + } + } +} +``` + +In the third example the item "Metric3" is added to the array "perfMetrics". The value of "perfMetrics" contains the two old items and the new item. + +``` +PATCH /SubNetwork=SN1/PerfMetricJob=PMJ1 HTTP/1.1 +Host: example.org +Content-Type: application/merge-patch+json + +{ + "id": "PMJ1", + "attributes": { + "perfMetrics": ["Metric1", "Metric2", "Metric3"] + } +} +``` + +Also in case the items of an array have an identifier, the complete updated array value needs to be present in the patch request. In the following fourth example in this clause the old first threshold level is deleted, for the old second threshold level the "thresholdValue" is updated from "20" to "22", the old third threshold level is left unchanged, and a new threshold level is appended as last item. + +``` +PATCH /SubNetwork=SN1/ThresholdMonitor=TM1 HTTP/1.1 +Host: example.org +Content-Type: application/merge-patch+json + +{ + "id": "TM1", + "attributes": { + "thresholdLevels": [ + { + "level": "2", + "thresholdValue": 22 + }, + { + "level": "3", + +``` + +``` + "thresholdValue": 30 + }, + { + "level": "4", + "thresholdValue": 40 + } +] +} +} +``` + +### A.6.2 Partial update of a resource with 3GPP JSON Merge Patch + +When updating a single resource, there is no difference between JSON Merge Patch (see A.6.1) and 3GPP JSON Merge Patch. + +### A.6.3 Partial update of a resource with JSON Patch + +When JSON Patch is used to request the same changes as the ones described in the four examples in clause A.6.1, the MnS consumer may send + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "replace", + "path": "/attributes/attrA", + "value": "def" + } +] +``` + +and + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "replace", + "path": "/attributes/plmnId/mcc", + "value": 654 + } +] +``` + +and + +``` +PATCH /SubNetwork=SN1/PerfMetricJob=PMJ1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/perfMetrics/2", + "value": "Metric3" + } +] +``` + +and + +``` +PATCH /SubNetwork=SN1/ThresholdMonitor=TM1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ +``` + +``` + +[ + { + "op": "remove", + "path": "/attributes/thresholdLevels/0" + }, + { + "op": "replace", + "path": "/attributes/thresholdLevels/0/thresholdValue", + "value": 22 + }, + { + "op": "add", + "path": "/attributes/thresholdLevels/-", + "value": + { + "level": "4", + "thresholdValue": 40 + } + } +] + +``` + +Note that the patch operations are applied sequentially to the "thresholdLevels" array in the order they appear in the patch array. After removing the first array item with the first operation, the resulting array value becomes the target for the second operation. The array index "0" identifies the new first item, which was the second item before applying the first operation of the patch document. Issues with array positions can be avoided by placing "replace" operations at the beginning of the patch document. + +In the examples above the value of "value" is always a simple type (scalar value). When multiple attribute fields of an attribute need to be added or replaced, it is often more compact to add or replace the complete attribute with a single patch operation, instead of each attribute field individually. For example, the following patch + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/plmnId/mcc", + "value": 456 + }, + { + "op": "add", + "path": "/attributes/plmnId/mnc", + "value": 789 + } +] + +``` + +can be replaced by + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/plmnId", + "value": { + "mcc": 456, + "mnc": 789 + } + } +] + +``` + +When adding a member to a JSON object, the JSON object needs to exist. Assume "plmnId" does not exist, but "attributes" does, then the following request is an error, since it attempts to add a "mcc" member to the "plmnId" object, that does not exist + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +``` + +``` +[ + { + "op": "add", + "path": "/attributes/plmnId/mcc", + "value": 654 + } +] +``` + +The MnS Consumer should send the following instead. + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/plmnId", + "value": { + "mcc": 654 + } + } +] +``` + +Alternatively, an empty "plmnId" object could be created before adding the "mcc" member. + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "add", + "path": "/attributes/plmnId", + "value": {} + }, + { + "op": "add", + "path": "/attributes/plmnId/mcc", + "value": 654 + } +] +``` + +Replacing all attribute values of an object is a special case of a partial resource update. The following example demonstrates the usage of a compact format where the "attributes" container is replaced completely. It is not necessary to specify a patch operation for each attribute of the object. + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/json-patch+json + +[ + { + "op": "replace", + "path": "/attributes", + "value": { + "attrA": "def", + "attrB": 123 + } + } +] +``` + +Note that clause 4.3 of IETF RFC 6902 [13] does not consider it as an error if an attribute value is replaced with exactly the same value. For that reason it would not be an error if in the example above an attribute value is included in the "value" property that is equal to the value in the current resource representation. A MnS Producer may consider this compact format hence also for the case that not all attributes of an object are requested to be updated with a new value. + +### A.6.4 Partial update of a resource with 3GPP JSON Patch + +When 3GPP JSON Patch is used to request the changes described in the first two examples in clause A.6.1 the MnS consumer may send the following + +``` +PATCH /SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "replace", + "path": "#/attributes/attrA", + "value": "def" + } +] +``` + +and + +``` +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "replace", + "path": "#/attributes/plmnId/mcc", + "value": 654 + } +] +``` + +and + +``` +PATCH /SubNetwork=SN1/ThresholdMonitor=TM1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "remove", + "path": "#/attributes/thresholdLevels/0" + }, + { + "op": "replace", + "path": "#/attributes/thresholdLevels/0/thresholdValue", + "value": 22 + }, + { + "op": "add", + "path": "#/attributes/thresholdLevels/-", + "value": + { + "level": "4", + "thresholdValue": 40 + } + } +] +``` + +When using 3GPP JSON Patch to update a single resource, the only difference compared to JSON Patch is the presence of "#" in the "path". + +## A.7 Manipulating multiple resources + +### A.7.1 Manipulating multiple resources with 3GPP JSON Merge Patch + +JSON Merge Patch allows to update one resource only with a single HTTP PATCH request. The resource needs to exist. In contrast, 3GPP JSON Merge Patch allows to update multiple resources incl. resource creation and deletion with a single HTTP PATCH + +In the following example the "userLabel" attribute and the "mcc" attribute field of the "SubNetwork" resource are updated. The "attrB" attribute of the "XyzFunction" resource, whose "id" is "XYZF1", is also updated. A new "XyzFunction" resource with id "XYZF3" is created as well as a new "ManagedElement" resource with id "ME3". The "XyzFunction" resource, whose "id" is "XYZF2", is deleted. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.merge-patch+json + +{ + "id": "SN1", + "attributes": { + "userLabel": "Berlin NW-1", + "plmnId": { + "mcc": 654 + } + }, + "ManagedElement": [ + { + "id": "ME1", + "XyzFunction": [ + { + "id": "XYZF1", + "attributes": { + "attrB": 1234 + } + }, + { + "id": "XYZF2", + "attributes": null + }, + { + "id": "XYZF3", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "fgh", + "attrB": 555 + } + } + ] + }, + { + "id": "ME3", + "objectClass": "ManagedElement", + "attributes": { + "userLabel": " Berlin NW 3", + "vendorName": "Company XY", + "location": "Spandau" + } + } + ] +} + +``` + +### A.7.2 Manipulating multiple resources with 3GPP JSON PATCH + +The same resource modifications as in the previous clause expressed using 3GPP JSON Patch are given by + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json + +[ + { + "op": "replace", + "path": "#/attributes/userLabel", + "value": "Berlin NW-1" + }, + { + "op": "replace", + "path": "#/attributes/plmnId/mcc", + "value": 654 + }, + { + "op": "replace", + +``` + +``` + + "path": "ManagedElement=ME1/XyzFunction=XYZF1#/attributes/attrB", + "value": 1234 + }, + { + "op": "add", + "path": "/ManagedElement=ME1/XyzFunction=XYZF3", + "value": { + "id": "XYZF3", + "objectClass": "XyzFunction", + "attributes": { + "attrA": "ghi", + "attrB": 553 + } + } + }, + { + "op": "remove", + "path": "/ManagedElement=ME1/XyzFunction=XYZF2" + }, + { + "op": "add", + "path": "/ManagedElement=ME3", + "value": { + "id": "ME3", + "objectClass": "ManagedElement", + "attributes": { + "userLabel": " Berlin NW 3", + "vendorName": "Company XY", + "location": "Spandau" + } + } + } +] + +``` + +The modifications of the "userLabel" attribute and the "mcc" attribute field can be expressed also by a single "merge" operation instead of two separate "replace" operations. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "merge", + "path": "#/attributes", + "value": { + "userLabel": "Berlin NW-1", + "plmnId": { + "mcc": 654 + } + } + } +] + +``` + +The "copy" operation is useful when complete configurations from existing resources need to be copied to newly created resources. + +``` + +PATCH /SubNetwork=SN1 HTTP/1.1 +Host: example.org +Content-Type: application/vnd.3gpp.json-patch+json +Accept: application/json +[ + { + "op": "add", + "path": "/ManagedElement=ME1/XyzFunction=XYZF3", + "value": { + "id": "XYZF3", + "objectClass": "XyzFunction", + "attributes": { + } + } + }, + { + "op": "copy", + "from": "/ManagedElement=ME1/XyzFunction=XYZF2/attributes", + "path": "/ManagedElement=ME1/XyzFunction=XYZF3/attributes" + } +] + +``` + +``` +} +] +``` + +## A.8 Partitioning a data model + +All objects of the data model in annex A.1 may be accessed and manipulated via a single MnS Producer endpoint, for example + +``` +http://example.org/3gpp/ProvMnS/v1600 +``` + +An implementation may also provide more than one endpoint for accessing the data model. This may be for allowing MnS Producers supporting different versions of the CRUD operations to access the data model: + +``` +http://example.org/3gpp/ProvMnS/v1600 +http://example.org/3gpp/ProvMnS/v1700 +``` + +Another reason might be to structure the total data model into subsets of managed objects for different purposes such as configuration management and performance management. + +``` +http://example.org/3gpp/cm/ProvMnS/v1600 +http://example.org/3gpp/pm/ProvMnS/v1600 +``` + +Using the MnS Producer endpoint for configuration management only the objects for configuration management can be accessed. The canonical URIs of these objects are + +``` +http://example.org/SubNetwork=SN1 +http://example.org/SubNetwork=SN1/ManagedElement=ME1 +http://example.org/SubNetwork=SN1/ManagedElement=ME2 +http://example.org/SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 +http://example.org/SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF2 +``` + +Using the MnS Producer endpoint for performance management only the objects for performance management can be accessed. + +``` +http://example.org/SubNetwork=SN1/PerfMetricJob=PMJ1 +http://example.org/SubNetwork=SN1/ThresholdMonitor=TM1 +``` + +When trying to access with the MnS Producer for performance management an object pertaining to the subset of managed objects for configuration management, for example, + +``` +GET /3gpp/fm//SubNetwork=SN1/ManagedElement=ME1/XyzFunction=XYZF1 HTTP/1.1 +Host: example.org +Accept: application/json +``` + +an error is raised, for example "403 Forbidden" or "404 Not Found". \ No newline at end of file diff --git a/marked/Rel-18/32_series/32160/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/32_series/32160/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e79538360ca347d0de1fdae8800493987c9aea0e --- /dev/null +++ b/marked/Rel-18/32_series/32160/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbcbcf01a0152c32648e57c2c23d08145e233fbc9e96e7d9200366766e060cb3 +size 9159 diff --git a/marked/Rel-18/32_series/32160/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/32_series/32160/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5e0eaf0aeb4772da9ff1633c1d520916a2bcbb36 --- /dev/null +++ b/marked/Rel-18/32_series/32160/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da9ff6743d6368c758b0b8ca614f07196897e9796b8aa11e7e270266e9e36bc5 +size 5692 diff --git a/marked/Rel-18/32_series/32160/raw.md b/marked/Rel-18/32_series/32160/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2bdb66d146eaad89537a36e781972c5c143d1ac5 --- /dev/null +++ b/marked/Rel-18/32_series/32160/raw.md @@ -0,0 +1,2153 @@ + + +# 3GPP TS 32.160 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Management and orchestration; Management service template (Release 18)** --- + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' in smaller letters below the logo. + +3GPP logo + +## --- **Keywords** + +management, service, template + +## **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. + +© 2023, 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 ..... | 6 | +| 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 Management service template (stage 1)..... | 9 | +| 4.1 General ..... | 9 | +| 4.2 Template for requirement specifications..... | 9 | +| 5 Management service template (stage 2)..... | 10 | +| 5.1 General ..... | 10 | +| 5.1.1 General ..... | 10 | +| 5.1.2 Management service components..... | 11 | +| 5.2 Template for NRM..... | 11 | +| 5.3 Template for Management service operations and notifications ..... | 17 | +| 6 NRM Stage 3 definition rules ..... | 22 | +| 6.1 Mappings from stage 2 artefacts to stage 3 JSON schema ..... | 22 | +| 6.1.1 Usage of JSON schema ..... | 22 | +| 6.1.2 Concrete NRM classes ..... | 22 | +| 6.1.3 Abstract classes ..... | 23 | +| 6.1.4 Name containment..... | 23 | +| 6.1.5 Recursive name containment..... | 25 | +| 6.1.6 Inheritance ..... | 25 | +| 6.1.7 NRM class naming attribute "id"..... | 26 | +| 6.1.8 NRM class attributes ..... | 26 | +| 6.1.9 Vendor specific extensions..... | 26 | +| 6.1.10 Attribute support qualifier ..... | 27 | +| 6.1.11 Attribute properties..... | 27 | +| 6.1.11.1 Introduction..... | 27 | +| 6.1.11.2 Attribute property "multiplicity" ..... | 27 | +| 6.1.11.3 Attribute property "isUnique" ..... | 27 | +| 6.1.11.4 Attribute property "isOrdered" ..... | 27 | +| 6.1.11.5 Attribute property "defaultValue" ..... | 28 | +| 6.1.11.6 Attribute property "isNullable" ..... | 28 | +| 6.1.11.7 Attribute property "isInvariant" ..... | 28 | +| 6.1.11.8 Attribute property "isReadable" and "isWritable" ..... | 28 | +| 6.1.11.9 Attribute property "isNotifyable" ..... | 28 | +| 6.1.11.10 Attribute property "allowedValues" ..... | 28 | +| 6.1.11.11 Attribute property "lifecycleStatus"..... | 29 | +| 6.2 Stage 3 YANG style and example..... | 29 | +| 6.2.1 General Modeling Rules..... | 29 | +| 6.2.1.1 Modeling Resources ..... | 29 | +| 6.2.1.2 Unique YANG Module names ..... | 29 | +| 6.2.1.3 Unique YANG Namespace..... | 29 | +| 6.2.1.4 Unique YANG Module Prefixes..... | 29 | +| 6.2.1.5 Use YANG version 1.1 ..... | 29 | +| 6.2.1.6 YANG constructs not to be used – not recommended..... | 30 | +| 6.2.1.7 Reuse standards from other standard organizations ..... | 30 | +| 6.2.1.8 Vendor specific model changes ..... | 30 | +| 6.2.1.9 Model correctness, checking..... | 31 | +| 6.2.1.10 YANG modules in technical specifications..... | 31 | +| 6.2.1.11 Module header statements ..... | 31 | + +| | | | +|-----------|--------------------------------------------------------------------|----| +| 6.2.1.12 | Provide description and reference statements..... | 32 | +| 6.2.1.13 | YANG module revisions ..... | 32 | +| 6.2.1.15 | Don't use YANG statements with their default meaning ..... | 32 | +| 6.2.1.16 | Formatting YANG modules/submodules ..... | 32 | +| 6.2.1.17 | Use original prefix under import statements..... | 33 | +| 6.2.1.18 | YANG Naming ..... | 33 | +| 6.2.1.19 | Copyright ..... | 33 | +| 6.2.2 | InformationObjectClass – abstract ..... | 33 | +| 6.2.2.1 | Introduction..... | 33 | +| 6.2.2.2 | YANG mapping..... | 33 | +| 6.2.3 | Naming attribute ..... | 34 | +| 6.2.3.1 | Introduction..... | 34 | +| 6.2.3.2 | Yang mapping..... | 34 | +| 6.2.4 | InformationObjectClass – concrete ..... | 34 | +| 6.2.4.0 | Introduction..... | 34 | +| 6.2.4.1 | YANG mapping..... | 34 | +| 6.2.5 | Generalization relationship - inheritance from another class ..... | 35 | +| 6.2.5.1 | Introduction..... | 35 | +| 6.2.5.2 | YANG mapping..... | 35 | +| 6.2.6 | Name containment..... | 35 | +| 6.2.6.1 | Introduction..... | 35 | +| 6.2.6.2 | YANG mapping..... | 36 | +| 6.2.6.2.1 | General..... | 36 | +| 6.2.6.2.2 | Simple augment..... | 36 | +| 6.2.6.2.3 | Uses + Subtree grouping ..... | 37 | +| 6.2.7 | Recursive containment - reference based solution ..... | 38 | +| 6.2.8 | Multi-root management tree ..... | 39 | +| 6.2.9 | Alternative containment ..... | 39 | +| 6.2.10 | Attribute – simple, single value..... | 39 | +| 6.2.10.1 | Introduction..... | 39 | +| 6.2.10.2 | YANG Mapping ..... | 40 | +| 6.2.11 | Attribute – simple, multivalue ..... | 40 | +| 6.2.11.1 | Introduction..... | 40 | +| 6.2.11.2 | YANG mapping..... | 40 | +| 6.2.12 | Attribute, structured..... | 40 | +| 6.2.12.0 | Introduction..... | 40 | +| 6.2.12.1 | YANG Mapping ..... | 40 | +| 6.2.13 | defaultValue ..... | 41 | +| 6.2.13.1 | Introduction..... | 41 | +| 6.2.13.2 | YANG mapping..... | 42 | +| 6.2.14 | multiplicity and cardinality..... | 42 | +| 6.2.14.0 | Introduction..... | 42 | +| 6.2.14.1 | YANG mapping..... | 42 | +| 6.2.15 | isNullable..... | 42 | +| 6.2.15.0 | Introduction..... | 42 | +| 6.2.15.1 | YANG mapping..... | 42 | +| 6.2.16 | dataType ..... | 43 | +| 6.2.16.0 | Introduction..... | 43 | +| 6.2.16.1 | YANG mapping..... | 43 | +| 6.2.17 | enumeration ..... | 43 | +| 6.2.17.0 | Introduction..... | 43 | +| 6.2.17.1 | YANG mapping..... | 43 | +| 6.2.18 | choice..... | 43 | +| 6.2.18.0 | Introduction..... | 43 | +| 6.2.18.1 | YANG mapping..... | 43 | +| 6.2.19 | isInvariant on attribute..... | 43 | +| 6.2.19.1 | YANG mapping..... | 43 | +| 6.2.20 | isReadable/isWritable..... | 44 | +| 6.2.20.1 | YANG mapping..... | 44 | +| 6.2.21 | isOrdered ..... | 44 | +| 6.2.21.1 | YANG mapping..... | 44 | +| 6.2.22 | isUnique..... | 44 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------|-----------| +| 6.2.22.1 | YANG mapping ..... | 44 | +| 6.2.23 | allowedValues ..... | 44 | +| 6.2.23.1 | YANG mapping ..... | 44 | +| 6.2.24 | Xor constraint ..... | 44 | +| 6.2.24.1 | YANG mapping ..... | 45 | +| 6.2.25 | ProxyClass ..... | 45 | +| 6.2.25.1 | YANG mapping ..... | 45 | +| 6.2.26 | SupportQualifier ..... | 45 | +| 6.2.26.1 | Introduction ..... | 45 | +| 6.2.26.2 | YANG mapping ..... | 45 | +| 6.2.27 | isNotifyable ..... | 45 | +| 6.2.27.1 | Introduction ..... | 45 | +| 6.2.27.2 | YANG mapping ..... | 45 | +| Annex A (informative): | Example usage of the template for one management capability ..... | 47 | +| Annex B (informative): | Change history ..... | 48 | + +# 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 contains the templates to be used for the production of Management service component specifications type A, type B and type C [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.533: "Management and orchestration; Architecture framework". +- [3] 3GPP TS 32.156: "Telecommunication management; Fixed Mobile Convergence (FMC) Model Repertoire" +- [4] ITU-T Recommendation M.3020 (07/2017): "Management interface specification methodology". +- [5] 3GPP TR 21.801: "Specification drafting rules". +- [6] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [8] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)". +- [9] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [10] ITU-T Recommendation M.3020 (07/2011): "Management interface specification methodology" – Annex E "Information type definitions – type repertoire". +- [11] IETF RFC 8407: "[Guidelines for Authors and Reviewers of Documents Containing YANG Data Models, October 2018](#)". +- [12] 3GPP TS 28.532: " Management and orchestration; Generic management services" +- [13] IETF RFC 8528: "YANG Schema mount " +- [14] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [15] draft-wright-json-schema-01 (October 2017): "JSON Schema: A Media Type for Describing JSON Documents". +- [16] draft-wright-json-schema-validation-01 (October 2017): "JSON Schema Validation: A Vocabulary for Structural Validation of JSON". + +- [17] draft-wright-json-schema-hyperschema-01 (October 2017): "JSON Hyper-Schema: A Vocabulary for Hypermedia Annotation of JSON. +- [18] IETF RFC 7950: "The YANG 1.1 Data Modeling Language, August 2016". +- [19] [IETF RFC 8525](#): " YANG Library". +- [20] 3GPP TS 28.623: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions" + +# --- 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]. + +| | | +|-----|------------------------| +| C | Conditional | +| CM | Conditional Mandatory | +| CO | Conditional Optional | +| M | Mandatory | +| MnS | Management Service | +| NRM | Network Resource Model | +| O | Optional | + +# --- 4 Management service template (stage 1) + +## 4.1 General + +This template shall be used for the production of all requirement specifications for management and orchestration of 3GPP networks. + +Instructions in *italics* below shall not be included in the requirements specifications. + +Usage of fonts shall be according to the 3GPP drafting rules in TR 21.801 [5] for a TS (with some basic examples given in the 3GPP TS template). + +## 4.2 Template for requirement specifications --- + +### X Management capabilities + +### X.a + +*The management capability name above shall be replaced with the name of the management capability which is to be specified.* + +#### X.a.1 Description + +*For production of the contents of this clause, describe general information about the management capability.* + +#### X.a.2 Use cases + +##### X.a.2.b