ETSI GR CIM 038 V1.1.1 (2024-11)

Context Information Management (CIM); YANG and NGSI-LD interoperability

DGR/CIM-0038

General Information

• Status: Not Published
• Technical Committee: CIM - cross-cutting Context Information Management
• Current Stage: 12 - Citation in the OJ (auto-insert)
• Due Date: 11-Nov-2024
• Completion Date: 04-Nov-2024

Standards Content (Sample)

GROUP REPORT
Context Information Management (CIM);
YANG and NGSI-LD interoperability
Disclaimer
The present document has been produced and approved by the cross-cutting Context Information Management (CIM) ETSI
Industry Specification Group (ISG) and represents the views of those members who participated in this ISG.
It does not necessarily represent the views of the entire ETSI membership.

2 ETSI GR CIM 038 V1.1.1 (2024-11)

Reference
DGR/CIM-0038
Keywords
data models, information model, interoperability,
network management, YANG
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871

Important notice
The present document can be downloaded from the
ETSI Search & Browse Standards application.
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 prevailing version of an ETSI
deliverable is the one made publicly available in PDF format on ETSI deliver.
Users should be aware that the present document may be revised or have its status changed,
this information is available in the Milestones listing.
If you find errors in the present document, please send your comments to
the relevant service listed under Committee Support Staff.
If you find a security vulnerability in the present document, please report it through our
Coordinated Vulnerability Disclosure (CVD) program.
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.

Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
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 2024.
All rights reserved.
ETSI
3 ETSI GR CIM 038 V1.1.1 (2024-11)
Contents
Intellectual Property Rights . 4
Foreword . 4
Modal verbs terminology . 4
Executive summary . 4
Introduction . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 6
3 Definition of terms, symbols and abbreviations . 7
3.1 Terms . 7
3.2 Symbols . 7
3.3 Abbreviations . 7
4 YANG to NGSI-LD mapping . 8
4.1 Introduction . 8
4.2 Core mapping rules . 8
4.2.0 Foreword . 8
4.2.1 YANG identity . 8
4.2.2 YANG container . 9
4.2.3 YANG list . 9
4.2.4 YANG leaf . 10
4.2.5 YANG leaf-l ist . 10
4.2.6 YANG anydata . 11
4.2.7 YANG anyxml . 11
4.3 Mapping YANG configuration and operational state data . 11
4.3.0 Foreword . 11
4.3.1 IETF-style data models . 11
4.3.1.1 Data models compatible with NMDA . 11
4.3.1.2 Traditional data models (split layout) . 12
4.3.2 OpenConfig data models . 13
Annex A: Mapping examples . 15
A.1 Mapping YANG identities . . 15
A.2 Mapping "ietf-interfaces" YANG data model . 16
Annex B: Mapping network management operations to the NGSI-LD API . 22
B.1 Architecture . 22
History . 23

ETSI
4 ETSI GR CIM 038 V1.1.1 (2024-11)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations
pertaining to these essential IPRs, if any, are 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 Directives including the ETSI IPR Policy, no investigation regarding the essentiality of IPRs,
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.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its

Members. 3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and of the 3GPP
Organizational Partners. oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and of the ®
oneM2M Partners. GSM and the GSM logo are trademarks registered and owned by the GSM Association.
Foreword
This Group Report (GR) has been produced by ETSI Industry Specification Group (ISG) cross-cutting Context
Information Management (CIM).
Modal verbs terminology
In the present document "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.
Executive summary
The present document is intended to provide developers and network operators with guidelines towards achieving
interoperability between Yet Another Next Language (YANG) [i.1] and the Next Generation Service Interface Linked
Data (NGSI-LD) information model [i.2]. The present document outlines a set of generic rules which can facilitate the
translation of YANG data into a knowledge graph based on the NGSI-LD standard [i.2]. Practical examples are
included throughout the present document to help readers understand the different types of mappings depending on the
characteristics of the network devices.
ETSI
5 ETSI GR CIM 038 V1.1.1 (2024-11)
Introduction
Since the advent of the YANG language within the IETF, the network industry has experienced an evolution towards
the management and automation of operation of network devices. Traditional network operations based on CLIs are
being replaced with APIs based on the YANG language and network management protocols. The amount and variety of
YANG data models developed by vendors, open source projects, and consortia has grown exponentially. This opens the
door to vast amounts of network data that operators can collect and integrate to optimize the management of the
network. In this sense, the NGSI-LD standard [i.2], with its information model and REST-based API, becomes an
enabler for integrating all these network data. To this end, the present document aims to provide guidelines towards
improving the interoperability between YANG and NGSI-LD.
Contributions to the present document have been supported by the European Union's Horizon 2020 research project
PALANTIR (Grant number 883335) and the European Union's Horizon 2020 research projects aerOS (Grant
number 101069732) and ROBUST-6G (Grant number 101139068).

ETSI
6 ETSI GR CIM 038 V1.1.1 (2024-11)
1 Scope
The present document targets developers and operators from the network and telecommunications industry who aim at
integrating YANG data in a graph, following the NGSI-LD information model [i.2] and leveraging the capabilities of
the NGSI-LD API [i.3]. The present document focuses on the mapping of the YANG metamodel [i.1] to the NGSI-LD
information model, proposing generic rules that can achieve an automatic or semi-automatic translation of YANG data
onto a graph based on the NGSI-LD standard [i.2]. Interactions with network devices using network management
protocols based on YANG are discussed in the present document (see Annex B), albeit implementation details on their
usage and mapping to the NGSI-LD API [i.3] are out of scope.
2 References
2.1 Normative references
Normative references are not applicable in the present document.
2.2 Informative references
References are either specific (identified by date of publication and/or edition num
...