ETSI GS NFV-SOL 011 V3.3.1 (2020-01)

Network Functions Virtualisation (NFV) Release 3; Protocols and Data Models; RESTful protocols specification for the Or-Or Reference Point

DGS/NFV-SOL011ed331

General Information

• Status: Published
• Publication Date: 15-Jan-2020
• Technical Committee: NFV SOL - Solutions
• Current Stage: 12 - Completion
• Due Date: 03-Feb-2020
• Completion Date: 16-Jan-2020

Standards Content (Sample)

ETSI GS NFV-SOL 011 V3.3.1 (2020-01)






GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 3;
Protocols and Data Models;
RESTful protocols specification for the Or-Or Reference Point
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 011 V3.3.1 (2020-01)



Reference
DGS/NFV-SOL011ed331
Keywords
API, data, management, model, NFV, protocol

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 011 V3.3.1 (2020-01)
Contents
Intellectual Property Rights . 6
Foreword . 6
Modal verbs terminology . 6
1 Scope . 7
2 References . 7
2.1 Normative references . 7
2.2 Informative references . 7
3 Definition of terms, symbols and abbreviations . 7
3.1 Terms . 7
3.2 Symbols . 7
3.3 Abbreviations . 8
4 General aspects . 8
4.1 Overview . 8
4.2 Common data types . 8
5 NSD Management interface . 8
6 NS Lifecycle Management interface . 9
7 NS Lifecycle Operation Granting interface . 9
7.1 Description . 9
7.2 API version . 9
7.3 Resource structure and method . 9
7.4 Sequence diagrams (informative) . 10
7.4.1 Flow of requesting a grant . 10
7.5 Resources . 10
7.5.1 Introduction. 10
7.5.2 Resource: API versions . 10
7.5.3 Resource: Grants . 10
7.5.3.1 Description . 10
7.5.3.2 Resource definition . 11
7.5.3.3 Resource methods . 11
7.5.3.3.1 POST . 11
7.5.3.3.2 GET . 12
7.5.3.3.3 PUT . 12
7.5.3.3.4 PATCH . 12
7.5.3.3.5 DELETE . 12
7.5.4 Resource: Individual grant . 12
7.5.4.1 Description . 12
7.5.4.2 Resource definition . 12
7.5.4.3 Resource methods . 12
7.5.4.3.1 POST . 12
7.5.4.3.2 GET . 12
7.5.4.3.3 PUT . 13
7.5.4.3.4 PATCH . 13
7.5.4.3.5 DELETE . 13
7.6 Data model . 13
7.6.1 Introduction. 13
7.6.2 Resource and notification data types . 13
7.6.2.1 Introduction . 13
7.6.2.2 Type: GrantNsLifecycleOperationRequest . 13
7.6.2.3 Type: Grant . 14
7.6.3 Referenced structured data types . 14
7.6.4 Referenced simple data types and enumerations . 14
7.6.4.1 Introduction . 14
ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS NFV-SOL 011 V3.3.1 (2020-01)
7.6.4.2 Simple data types . 14
7.6.4.3 Enumeration: NsLcmOperation . 15
8 NS Instance Usage Notification interface . 15
8.1 Description . 15
8.2 API version . 15
8.3 Resource structure and method . 15
8.4 Sequence diagrams (informative) . 16
8.4.1 Flow of managing subscriptions . 16
8.4.2 Flow of sending notifications. 18
8.5 Resources . 19
8.5.1 Introduction. 19
8.5.2 Resource: API versions . 19
8.5.3 Resource: Subscriptions . 19
8.5.3.1 Description . 19
8.5.3.2 Resource definition . 19
8.5.3.3 Resource methods . 20
8.5.3.3.1 POST . 20
8.5.3.3.2 GET . 21
8.5.3.3.3 PUT . 22
8.5.3.3.4 PATCH . 22
8.5.3.3.5 DELETE . 22
8.5.4 Resource: Individual subscription . 23
8.5.4.1 Description . 23
8.5.4.2 Resource definition . 23
8.5.4.3 Resource methods . 23
8.5.4.3.1 POST . 23
8.5.4.3.2 GET . 23
8.5.4.3.3 PUT . 24
8.5.4.3.4 PATCH . 24
8.5.4.3.5 DELETE . 24
8.5.5 Resource: Notification endpoint . 24
8.5.5.1 Description . 24
8.5.5.2 Resource definition . 24
8.5.5.3 Resource methods . 25
8.5.5.3.1 POST . 25
8.5.5.3.2 GET . 25
8.5.5.3.3 PUT . 25
8.5.5.3.4 PATCH . 26
8.5.5.3.5 DELETE . 26
8.6 Data model . 26
8.6.1 Introduction. 26
8.6.2 Resource and notification data types . 26
8.6.2.1 Introduction . 26
8.6.2.2 Type: NsInstanceUsageSubscriptionRequest . 26
8.6.2.3 Type: NsInstanceUsageSubscription . 26
8.6.2.4 Type: NsInstanceUsageNotification . 27
8.6.3 Referenced structured data types . 27
8.6.3.1 Type: NsInstanceUsageNotificationsFilter . 27
8.6.4 Referenced simple data types and enumerations . 28
8.6.4.1 Introduction . 28
8.6.4.2 Simple data types . 28
8.6.4.3 Enumeration: NsInstanceUsageStatusType . 28
9 NS Performance Management interface . 28
10 NS Fault Management interface . 28
Annex A (informative): Mapping operations to protocol elements . 29
A.1 Overview . 29
A.2 NSD Management interface . 29
ETSI

---------------------- Page: 4 ----------------------
5 ETSI GS NFV-SOL 011 V3.3.1 (2020-01)
A.3 NS lifecycle management interface . 29
A.4 NS lifecycle operation granting interface . 30
A.5 NS instance usage notification interface . 30
A.6 NS performance management interface . 30
A.7 NS fault management interface . 31
Annex B (informative): Change History . 32
History . 33


ETSI

---------------------- Page: 5 ----------------------
6 ETSI GS NFV-SOL 011 V3.3.1 (2020-01)
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: 6 ----------------------
7 ETSI GS NFV-SOL 011 V3.3.1 (2020-01)
1 Scope
The present document specifies a set of RESTful protocol and data models fulfilling the requirements specified in ETSI
GS NFV-IFA 030 [1] for the interfaces used over the Or-Or reference point.
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 030: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; Multiple Administrative Domain Aspect Interfaces Specification".
[2] ETSI GS NFV-SOL 013: "Network Functions Virtualisation (NFV) Release 2; Protocols and Data
Models; Specification of common aspects for RESTful NFV MANO APIs".
[3] ETSI GS NFV-SOL 005: "Network Functions Virtualisation (NFV) Release 2; Protocols and Data
Models; RESTful protocols specification for the Os-Ma-nfvo Reference Point".
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] 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.1] and ETSI GS NFV-IFA 030 [1]
apply.
3.2 Symbols
Void.
ETSI

---------------------- Page: 7 ----------------------
8 ETSI GS NFV-SOL 011 V3.3.1 (2020-01)
3.3 Abbreviations
For the purposes of the present document, the abbreviations given in ETSI GS NFV 003 [i.1] and the following apply:
HTTP HyperText Transfer Protocol
4 General aspects
4.1 Overview
The present document defines the protocol and data model for the following interfaces, in the form of RESTful
Application Programming Interface (APIs) specifications:
• NSD Management interface (as produced by the NFVO-N towards the NFVO-C)
• NS Lifecycle Management interface (as produced by the NFVO-N towards the NFVO-C)
• NS Lifecycle Operation Granting interface (as produced by the NFVO-N towards the NFVO-C)
• NS Instance Usage Notification interface (as produced by the NFVO-N towards the NFVO-C)
• NS Performance Management interface (as produced by the NFVO-N towards the NFVO-C)
• NS Fault Management interface (as produced by the NFVO-N towards the NFVO-C)
The design of the protocol and data model for the above interfaces is based on the information model and requirements
defined in ETSI GS NFV-IFA 030 [1].
In the subsequent clauses, the protocol and data model for the individual interfaces are specified. Per interface, the
resource structure with associated HTTP methods is defined and applicable flows are provided. Further, the resources
and the data model are specified in detail.
Annex A provides the mapping of the combination of resources and methods defined in the present document to the
operations defined in ETSI GS NFV-IFA 030 [1].
Even though the various interfaces defined in the present document are related, implementations shall not assume a
particular order of messages that arrive via different interfaces.
4.2 Common data types
The structured data types and simple data types defined in clause 7 of ETSI GS NFV-SOL 013 [2] shall apply in the
present document.
5 NSD Management interface
This interface allows the NFVO-C to invoke management operations of NSDs towards the NFVO-N.
The interface shall follow the provisions specified in the clause 5 of ETSI GS NFV-SOL 005 [3] for the NSD management
interface, except that the producer is NFVO-N and the consumer is NFVO-C.
Only the "query NSD info" operation as defined in clause 5 of ETSI GS NFV-SOL 005 [3] is supported on the Or-Or
reference point, i.e. only the "NS Descriptors" and "Individual NS Descriptor" resources with the GET method are
supported for the present interface, and the API producer shall return a "405 Method Not Allowed" response for other
methods requested on the "NS Descriptors" and "Individual NS Descriptor" resources, as defined in clause 6.4 of ETSI
GS NFV-SOL 013 [2].
ETSI

---------------------- Page: 8 ----------------------
9 ETSI GS NFV-SOL 011 V3.3.1 (2020-01)
6 NS Lifecycle Management interface
This interface allows the NFVO-C to invoke NS lifecycle management operations of NS instances towards the NFVO-N,
and to subscribe to notifications regarding NS lifecycle changes provided by the NFVO-N.
The interface shall follow the provisions specified in the clause 6 of ETSI GS NFV-SOL 005 [3] for the NS lifecycle
management interface, except that the producer is NFVO-N and the consumer is NFVO-C.
The "update NS" as defined in clause 6 of ETSI GS NFV-SOL 005 [3] is not supported on the Or-Or reference point,
i.e. the "Update NS task" resource and related methods are not supported for the present interface, and the API producer
shall return a "404 Not Found" response for all methods requested on the "update NS" resource, as defined in clause 6.4
of ETSI GS NFV-SOL 013 [2].
7 NS Lifecycle Operation Granting interface
7.1 Description
This interface allows the NFVO-N to obtain from the NFVO-C permission for an NS lifecycle operations. This
interface also allows API version information retrieval.
The operations provided through this interface are:
• Grant NS Lifecycle Operation
7.2 API v
...