ETSI GS NFV-SOL 005 V2.8.1 (2020-09)

Network Functions Virtualisation (NFV) Release 2; Protocols and Data Models; RESTful protocols specification for the Os-Ma-nfvo Reference Point

RGS/NFV-SOL005ed281

General Information

• Status: Not Published
• Technical Committee: NFV SOL - Solutions
• Current Stage: 12 - Completion
• Due Date: 30-Jul-2020
• Completion Date: 07-Sep-2020

Standards Content (Sample)

ETSI GS NFV-SOL 005 V2.8.1 (2020-09)






GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 2;
Protocols and Data Models;
RESTful protocols specification for
the Os-Ma-nfvo 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 005 V2.8.1 (2020-09)



Reference
RGS/NFV-SOL005ed281
Keywords
API, 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 005 V2.8.1 (2020-09)
Contents
Intellectual Property Rights . 18
Foreword . 18
Modal verbs terminology . 18
1 Scope . 19
2 References . 19
2.1 Normative references . 19
2.2 Informative references . 20
3 Definition of terms, symbols and abbreviations . 21
3.1 Terms . 21
3.2 Symbols . 21
3.3 Abbreviations . 21
4 General Aspects . 22
4.1 Overview . 22
4.2 Void . 23
4.3 Void . 23
4.4 Common data types . 23
4.4.1 Structured data types . 23
4.4.1.1 Introduction . 23
4.4.1.2 Void. 23
4.4.1.3 Void. 23
4.4.1.3a Void. 23
4.4.1.4 Void. 23
4.4.1.5 Type: NsInstanceSubscriptionFilter . 23
4.4.1.6 Type: ResourceHandle . 24
4.4.1.7 Void. 24
4.4.2 Simple data types and enumerations . 25
4.4.2.1 Introduction . 25
4.4.2.2 Simple data types . 25
4.4.2.3 Enumerations . 25
4.5 Void . 25
4.6 Void . 25
4.7 Void . 25
5 NSD Management interface . 25
5.1 Description . 25
5.1a API version . 26
5.2 Resource structure and methods . 26
5.3 Sequence diagrams (informative) . 28
5.3.1 Flow of the creation of an individual NS descriptor resource . 28
5.3.2 Flow of the uploading of NSD archive content . 29
5.3.3 Flow of the fetching of an onboarded NSD archive . 30
5.3.4 Flow of the update of an individual NS descriptor resource . 31
5.3.5 Flow of the deletion of an individual NS descriptor resource . 32
5.3.6 Flow of the querying/reading of NS descriptor information . 33
5.3.6a Flow of reading the NSD . 34
5.3.6b Flow of fetching the manifest file of an onboarded NSD archive. 34
5.3.7 Flow of the creation of an individual PNF descriptor resource . 35
5.3.8 Flow of the uploading of PNFD archive . 35
5.3.9 Flow of the fetching of an onboarded PNFD archive . 36
5.3.10 Flow of the deletion of an individual PNF descriptor resource . 37
5.3.11 Flow of the querying/reading of PNF descriptor information . 37
5.3.11a Flow of reading the PNFD . 39
5.3.11b Flow of fetching the manifest file of an onboarded PNFD archive . 39
5.3.12 Flow of managing subscriptions . 39
5.3.13 Flow of sending notifications. 41
ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS NFV-SOL 005 V2.8.1 (2020-09)
5.4 Resources . 42
5.4.1 Introduction. 42
5.4.1a Resource: API versions . 42
5.4.2 Resource: NS Descriptors . 42
5.4.2.1 Description . 42
5.4.2.2 Resource definition . 42
5.4.2.3 Resource methods . 43
5.4.2.3.1 POST . 43
5.4.2.3.2 GET . 43
5.4.2.3.3 PUT . 44
5.4.2.3.4 PATCH . 45
5.4.2.3.5 DELETE . 45
5.4.3 Resource: Individual NS Descriptor . 45
5.4.3.1 Description . 45
5.4.3.2 Resource definition . 45
5.4.3.3 Resource methods . 45
5.4.3.3.1 POST . 45
5.4.3.3.2 GET . 45
5.4.3.3.3 PUT . 46
5.4.3.3.4 PATCH . 46
5.4.3.3.5 DELETE . 47
5.4.4 Resource: NSD archive content . 48
5.4.4.1 Description . 48
5.4.4.2 Resource definition . 48
5.4.4.3 Resource methods . 49
5.4.4.3.1 POST . 49
5.4.4.3.2 GET . 49
5.4.4.3.3 PUT . 50
5.4.4.3.4 PATCH . 51
5.4.4.3.5 DELETE . 51
5.4.4a Resource: NSD . 51
5.4.4a.1 Description . 51
5.4.4a.2 Resource definition . 52
5.4.4a.3 Resource methods . 52
5.4.4a.3.1 POST . 52
5.4.4a.3.2 GET . 52
5.4.4a.3.3 PUT . 54
5.4.4a.3.4 PATCH . 54
5.4.4a.3.5 DELETE . 54
5.4.4b Resource: NSD archive manifest . 54
5.4.4b.1 Description . 54
5.4.4b.2 Resource definition . 54
5.4.4b.3 Resource methods . 54
5.4.4b.3.1 POST . 54
5.4.4b.3.2 GET . 54
5.4.4b.3.3 PUT . 56
5.4.4b.3.4 PATCH . 56
5.4.4b.3.5 DELETE . 56
5.4.5 Resource: PNF Descriptors . 56
5.4.5.1 Description . 56
5.4.5.2 Resource definition . 56
5.4.5.3 Resource methods . 56
5.4.5.3.1 POST . 56
5.4.5.3.2 GET . 57
5.4.5.3.3 PUT . 58
5.4.5.3.4 PATCH . 58
5.4.5.3.5 DELETE . 58
5.4.6 Resource: Individual PNF Descriptor . 59
5.4.6.1 Description . 59
5.4.6.2 Resource definition . 59
5.4.6.3 Resource methods . 59
5.4.6.3.1 POST . 59
ETSI

---------------------- Page: 4 ----------------------
5 ETSI GS NFV-SOL 005 V2.8.1 (2020-09)
5.4.6.3.2 GET . 59
5.4.6.3.3 PUT . 60
5.4.6.3.4 PATCH . 60
5.4.6.3.5 DELETE . 60
5.4.7 Resource: PNFD archive content . 61
5.4.7.1 Description . 61
5.4.7.2 Resource definition . 61
5.4.7.3 Resource methods . 62
5.4.7.3.1 POST . 62
5.4.7.3.2 GET . 62
5.4.7.3.3 PUT . 63
5.4.7.3.4 PATCH . 64
5.4.7.3.5 DELETE . 64
5.4.7a Resource: PNFD . 64
5.4.7a.1 Description . 64
5.4.7a.2 Resource definition . 65
5.4.7a.3 Resource methods . 65
5.4.7a.3.1 POST . 65
5.4.7a.3.2 GET . 65
5.4.7a.3.3 PUT . 66
5.4.7a.3.4 PATCH . 67
5.4.7a.3.5 DELETE . 67
5.4.7b Resource: PNFD archive manifest . 67
5.4.7b.1 Description . 67
5.4.7b.2 Resource definition . 67
5.4.7b.3 Resource methods . 67
5.4.7b.3.1 POST . 67
5.4.7b.3.2 GET . 67
5.4.7b.3.3 PUT . 69
5.4.7b.3.4 PATCH . 69
5.4.7b.3.5 DELETE . 69
5.4.8 Resource: Subscriptions . 69
5.4.8.1 Description . 69
5.4.8.2 Resource definition . 69
5.4.8.3 Resource methods . 69
5.4.8.3.1 POST . 69
5.4.8.3.2 GET . 70
5.4.8.3.3 PUT . 71
5.4.8.3.4 PATCH . 72
5.4.8.3.5 DELETE . 72
5.4.9 Resource: Individual subscription . 72
5.4.9.1 Description . 72
5.4.9.2 Resource definition . 72
5.4.9.3 Resource methods . 72
5.4.9.3.1 POST . 72
5.4.9.3.2 GET . 72
5.4.9.3.3 PUT . 73
5.4.9.3.4 PATCH . 73
5.4.9.3.5 DELETE . 73
5.4.10 Resource: Notification endpoint . 73
5.4.10.1 Description . 73
5.4.10.2 Resource definition .
...