ETSI GS NFV-SOL 006 V2.8.1 (2020-08)

Network Functions Virtualisation (NFV) Release 2; Protocols and Data Models; NFV Descriptors based on YANG Specification

RGS/NFV-SOL006ed281

General Information

• Status: Not Published
• Technical Committee: NFV SOL - Solutions
• Current Stage: 12 - Completion
• Due Date: 31-Aug-2020
• Completion Date: 20-Aug-2020

Standards Content (Sample)

ETSI GS NFV-SOL 006 V2.8.1 (2020-08)






GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 2;
Protocols and Data Models;
NFV Descriptors based on YANG Specification
Disclaimer
The present document has been produced and approved by the Network Functions Virtualisation (NFV) 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.


---------------------- Page: 1 ----------------------
2 ETSI GS NFV-SOL 006 V2.8.1 (2020-08)



Reference
RGS/NFV-SOL006ed281
Keywords
data, model, NFV, YANG

ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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:
http://www.etsi.org/standards-search
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 at www.etsi.org/deliver.
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
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
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 2020.
All rights reserved.

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.
ETSI

---------------------- Page: 2 ----------------------
3 ETSI GS NFV-SOL 006 V2.8.1 (2020-08)
Contents
Intellectual Property Rights . 4
Foreword . 4
Modal verbs terminology . 4
1 Scope . 5
2 References . 5
2.1 Normative references . 5
2.2 Informative references . 5
3 Definition of terms, symbols and abbreviations . 6
3.1 Terms . 6
3.2 Symbols . 6
3.3 Abbreviations . 6
4 Overview of YANG model . 6
4.1 General . 6
4.2 Conventions . 6
5 General concept of using YANG to model NFV descriptors . 7
5.1 Introduction . 7
5.2 Augmentation rules in YANG . 7
6 NFV YANG module definitions . 7
6.1 Introduction . 7
6.2 VNFD YANG Module definitions . 8
6.3 NSD YANG module definitions . 8
6.4 PNFD YANG module definitions . 8
6.5 Descriptors YANG module definitions . 8
6.6 Other YANG sub-module definitions. 8
6.7 Common YANG module definitions . 8
Annex A (informative): YANG modelling example for NFV . 9
A.1 Introduction . 9
A.2 Multi-DF example . 9
A.2.1 General . 9
A.2.2 Firewall Router Deployment Flavour Example . 9
A.2.3 Router Firewall DPI NS Deployment Flavour Example . 10
A.3 Extending VnfInfoModifiableAttributes . 11
A.4 Extending VnfLcmOperationsConfiguration . 11
Annex B (informative): Change History . 13
History . 15


ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS NFV-SOL 006 V2.8.1 (2020-08)
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 Group Specification (GS) has been produced by ETSI Industry Specification Group (ISG) Network Functions
Virtualisation (NFV).
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: 4 ----------------------
5 ETSI GS NFV-SOL 006 V2.8.1 (2020-08)
1 Scope
The present document specifies the YANG models for representing Network Functions Virtualisation (NFV)
descriptors, fulfilling the requirements specified in ETSI GS NFV-IFA 011 [1] and ETSI GS NFV-IFA 014 [2]
applicable to a Virtualised Network Function Descriptor (VNFD), a Physical Network Functions Descriptor (PNFD)
and a Network Service Descriptor (NSD).
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] ETSI GS NFV-IFA 011: "Network Functions Virtualisation (NFV) Release 2; Management and
Orchestration; VNF Descriptor and Packaging Specification".
[2] ETSI GS NFV-IFA 014: "Network Functions Virtualisation (NFV) Release 2; Management and
Orchestration; Network Service Templates Specification".
[3] IETF RFC 7950: "The YANG 1.1 Data Modeling Language".
NOTE: Available at https://tools.ietf.org/html/rfc7950.
[4] IETF RFC 7951: "JSON Encoding of Data Modeled with YANG".
NOTE: Available at https://tools.ietf.org/html/rfc7951.
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] IETF RFC 6241: "Network Configuration Protocol (NETCONF)".
NOTE: Available at https://tools.ietf.org/html/rfc6241.
[i.2] IETF RFC 8040: "RESTCONF Protocol".
NOTE: Available at https://tools.ietf.org/html/rfc8040.
[i.3] IETF RFC 8340: "YANG Tree Diagram".
NOTE: Available at https://tools.ietf.org/html/rfc8340.
ETSI

---------------------- Page: 5 ----------------------
6 ETSI GS NFV-SOL 006 V2.8.1 (2020-08)
[i.4] ETSI GS NFV-SOL 001: "Network Functions Virtualisation (NFV) Release 2; Protocols and Data
Models; NFV descriptors based on TOSCA specification".
[i.5] ETSI GS NFV 003: "Network Functions Virtualisation (NFV); Terminology for Main Concepts in
NFV".
3 Definition of terms, symbols and abbreviations
3.1 Terms
For the purposes of the present document, the terms given in ETSI GS NFV 003 [i.5] apply.
3.2 Symbols
Void.
3.3 Abbreviations
For the purposes of the present document, the abbreviations given in ETSI GS NFV 003 [i.5] and the following apply:
ASA Adaptive Security Appliance
CSR Cloud Service Router
DPI Deep Packet Inspection
HTML HyperText Markup Language
HTTP HyperText Transfer Protocol
JSON JavaScript Object Notation
REST Representational State Transfer
RPC Remote Procedure Call
URL Uniform Resource Locator
4 Overview of YANG model
4.1 General
The YANG data modelling language is defined in IETF RFC 7950 [3]. The YANG language is used to model
configuration and state data. IETF RFC 7950 [3] states that the data model represented by YANG is meant to be
manipulated by the Network Configuration Protocol (NETCONF) [i.1]. Since IETF RFC 7950 [3] was written
HTTP REST based protocols such as IETF RFC 8040 (RESTCONF) [i.2] have been specified and adopted for use with
YANG based models.
4.2 Conventions
There are some common YANG practices that dictate the naming convention in the model. First of all, YANG does not
use camel case in its naming. Instead it uses kebab-case, also known as lisp-case or cobol-case naming convention.
Therefore an attribute in the information model like defaultLocalizationLanguage would be represented as default-
localization-language in the YANG model.
The second thing about the YANG language is that it is hierarchical in nature. The top level container therefore
represents the parent for all the child nodes underneath it. Therefore, there is no need to repeat the name of the parent in
the child node. A child node vnfd-element-group-id in the parent container vnfd-element-group would simply be
renamed as id. Multiple entries of a certain attribute will be represented as list or leaf-list. To identify an entry in such a
list requires a key. A key in general is named as "id". Therefore all such identifiers have been renamed as "id" in the
model.
ETSI

---------------------- Page: 6 ----------------------
7 ETSI GS NFV-SOL 006 V2.8.1 (2020-08)
5 General concept of using YANG to model NFV
descriptors
5.1 Introduction
A NFV descriptor (VNFD, PNFD or NSD) is modelled using the YANG models defined in the present specification
and then encoded as JSON text using the using the procedures specified in IETF RFC 7951 [4].
One of the goals of the present document is to ensure that it is straight forward to translate between a TOSCA Service
Template which adheres to ETSI GS NFV-SOL 001 [i.4] and a JSON text document which adheres to the YANG
models specified in the present document.
YANG [3] is a data modelling language used to model configuration data, state data, RPCs, and notifications for
network management protocols. It is used by protocols such as NETCONF [i.1] and RESTCONF [i.2] to communicate
such configuration, state, RPC or notification data. NFV descriptors described in ETSI GS NFV-IFA 011 [1] and ETSI
GS NFV-IFA 014 [2], are therefore defined in th
...