|
TECHNICAL SPECIFICATION
Universal Mobile Telecommunications System (UMTS);
LTE;
Telecommunication management;
Integration Reference Point (IRP) Information Service (IS)
template
(3GPP TS 32.157 version 14.1.1 Release 14)
---------------------- Page: 1 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 1 ETSI TS 132 157 V14.1.1 (2018-09)
Reference
RTS/TSGS-0532157ve11
Keywords
LTE,UMTS
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
If you find errors in the present document, please send your comment to one of the following services:
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2018.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M logo is protected for the benefit of its Members.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 2 ETSI TS 132 157 V14.1.1 (2018-09)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Foreword
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or
GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables.
The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under
.
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
---------------------- Page: 3 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 3 ETSI TS 132 157 V14.1.1 (2018-09)
Contents
Intellectual Property Rights . 2
Foreword . 2
Modal verbs terminology . 2
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 . 13
Annex A (informative): Change history . 28
History . 29
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 4 ETSI TS 132 157 V14.1.1 (2018-09)
Foreword
rd
This Technical Specification has been produced by the 3 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.
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 5 ETSI TS 132 157 V14.1.1 (2018-09)
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".
ETSI
---------------------- Page: 6 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 6 ETSI TS 132 157 V14.1.1 (2018-09)
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:
IRPAgent: See 3GPP TS 32.150 [3].
IRPManager: 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
Courier New
Attribute names
Courier New
Operation names
Courier New
Parameter names
Courier New
Assertion names
Courier New
Notification names
Courier New
Exception names
State names Arial
Courier New
Matching Information
Information Type Courier New
Legal Values Courier New
NOTE: These font requirements do not apply to UML diagrams.
ETSI
---------------------- Page: 7 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 7 ETSI TS 132 157 V14.1.1 (2018-09)
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
IRPAgent and an IRPManager 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 ETSI
---------------------- Page: 8 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 8 ETSI TS 132 157 V14.1.1 (2018-09)
specifications>. 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 < list of relevant high-level 3GPP SA5 specifications>.
: .
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
Top
3GPP TS 32.622 [xy], information object class, 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
HSSFunction
3GPP TS 28.705 [12], IOC, HSSFunction
W4.2 Class diagram
W4.2.1 Relationships
ETSI
---------------------- Page: 9 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 9 ETSI TS 132 157 V14.1.1 (2018-09)
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
ETSI
---------------------- Page: 10 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 10 ETSI TS 132 157 V14.1.1 (2018-09)
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 The IOC SectorEquipmentFunction is used.
qualifier
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:
a) 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.
b) 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
ETSI
---------------------- Page: 11 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 11 ETSI TS 132 157 V14.1.1 (2018-09)
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.
ETSI
---------------------- Page: 12 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 12 ETSI TS 132 157 V14.1.1 (2018-09)
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
xyzId It identifies … type: Integer
allowedValues: … multiplicity: …
isOrdered: …
isUnique: …
defaultValue: …
isNullable: False
Abc.state It indicates … type: <>
multiplicity: 1
allowedValues: isOrdered: N/A
"ON": the state is on; isUnique: N/A
"OFF": the state is off. defaultValue: False
isNullable: False
Zyz.state It indicates … type: <>
multiplicity: 1
allowedValues: isOrdered: N/A
"HIGH": the state is high; isUnique: N/A
"MEDIUM": the state is medium; defaultValue: False
"LOW": the state is low. isNullable: False
abc It defines… type: …
multiplicity: …
allowedValues: … 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… type: <>
multiplicity: …
allowedValues: … isOrdered: …
isUnique: …
defaultValue: …
isNullable: …
Attribute related to role
aEnd It defines… type: DN
multiplicity: …
allowedValues: Values to be isOrdered: …
conformant to TS 32.300 [xy] … 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.
ETSI
---------------------- Page: 13 ----------------------
3GPP TS 32.157 version 14.1.1 Release 14 13 ETSI TS 132 157 V14.1.1 (2018-09)
An example is given here below:
Name Affected attribute(s) Definition
inv_Tim
...