|
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.6.1 (2019-04)
Reference
RGS/NFV-SOL005ed261
Keywords
API, NFV, protocol
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 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
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 2019.
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 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.6.1 (2019-04)
Contents
Intellectual Property Rights . 17
Foreword . 17
Modal verbs terminology . 17
1 Scope . 18
2 References . 18
2.1 Normative references . 18
2.2 Informative references . 19
3 Definition of terms, symbols and abbreviations . 19
3.1 Terms . 19
3.2 Symbols . 19
3.3 Abbreviations . 20
4 General Aspects . 21
4.1 Overview . 21
4.2 Void . 21
4.3 Void . 21
4.4 Common data types . 21
4.4.1 Structured data types . 21
4.4.1.1 Introduction . 21
4.4.1.2 Void. 22
4.4.1.3 Void. 22
4.4.1.3a Void. 22
4.4.1.4 Void. 22
4.4.1.5 Type: NsInstanceSubscriptionFilter . 22
4.4.1.6 Type: ResourceHandle . 22
4.4.1.7 Void. 23
4.4.2 Simple data types . 23
4.5 Void . 23
4.6 Void . 23
4.7 Void . 23
5 NSD Management interface . 23
5.1 Description . 23
5.1a API version . 24
5.2 Resource structure and methods . 24
5.3 Sequence diagrams (informative) . 26
5.3.1 Flow of the creation of an individual NS descriptor resource . 26
5.3.2 Flow of the uploading of NSD content . 27
5.3.3 Flow of the fetching of NSD content . 27
5.3.4 Flow of the update of an individual NS descriptor resource . 28
5.3.5 Flow of the deletion of an individual NS descriptor resource . 29
5.3.6 Flow of the querying/reading of NS descriptor resources . 30
5.3.7 Flow of the creation of an individual PNF descriptor resource . 31
5.3.8 Flow of the uploading of PNFD content . 32
5.3.9 Flow of the fetching of PNFD content . 33
5.3.10 Flow of the deletion of an individual PNF descriptor resource . 33
5.3.11 Flow of the querying/reading of PNF descriptor resources . 34
5.3.12 Flow of managing subscriptions . 35
5.3.13 Flow of sending notifications. 37
5.4 Resources . 38
5.4.1 Introduction. 38
5.4.1a Resource: API versions . 38
5.4.2 Resource: NS Descriptors . 38
5.4.2.1 Description . 38
5.4.2.2 Resource definition . 38
5.4.2.3 Resource methods . 39
ETSI
---------------------- Page: 3 ----------------------
4 ETSI GS NFV-SOL 005 V2.6.1 (2019-04)
5.4.2.3.1 POST . 39
5.4.2.3.2 GET . 39
5.4.2.3.3 PUT . 40
5.4.2.3.4 PATCH . 40
5.4.2.3.5 DELETE . 41
5.4.3 Resource: Individual NS Descriptor . 41
5.4.3.1 Description . 41
5.4.3.2 Resource definition . 41
5.4.3.3 Resource methods . 41
5.4.3.3.1 POST . 41
5.4.3.3.2 GET . 41
5.4.3.3.3 PUT . 42
5.4.3.3.4 PATCH . 42
5.4.3.3.5 DELETE . 43
5.4.4 Resource: NSD Content . 44
5.4.4.1 Description . 44
5.4.4.2 Resource definition . 44
5.4.4.3 Resource methods . 44
5.4.4.3.1 POST . 44
5.4.4.3.2 GET . 45
5.4.4.3.3 PUT . 46
5.4.4.3.4 PATCH . 47
5.4.4.3.5 DELETE . 47
5.4.5 Resource: PNF Descriptors . 48
5.4.5.1 Description . 48
5.4.5.2 Resource definition . 48
5.4.5.3 Resource methods . 48
5.4.5.3.1 POST . 48
5.4.5.3.2 GET . 49
5.4.5.3.3 PUT . 50
5.4.5.3.4 PATCH . 50
5.4.5.3.5 DELETE . 50
5.4.6 Resource: Individual PNF Descriptor . 50
5.4.6.1 Description . 50
5.4.6.2 Resource definition . 51
5.4.6.3 Resource methods . 51
5.4.6.3.1 POST . 51
5.4.6.3.2 GET . 51
5.4.6.3.3 PUT . 51
5.4.6.3.4 PATCH . 51
5.4.6.3.5 DELETE . 52
5.4.7 Resource: PNFD Content . 53
5.4.7.1 Description . 53
5.4.7.2 Resource definition . 53
5.4.7.3 Resource methods . 53
5.4.7.3.1 POST . 53
5.4.7.3.2 GET . 53
5.4.7.3.3 PUT . 54
5.4.7.3.4 PATCH . 55
5.4.7.3.5 DELETE . 55
5.4.8 Resource: Subscriptions . 55
5.4.8.1 Description . 55
5.4.8.2 Resource definition . 55
5.4.8.3 Resource methods . 56
5.4.8.3.1 POST . 56
5.4.8.3.2 GET . 56
5.4.8.3.3 PUT . 57
5.4.8.3.4 PATCH . 57
5.4.8.3.5 DELETE . 58
5.4.9 Resource: Individual subscription . 58
5.4.9.1 Description . 58
5.4.9.2 Resource definition . 58
ETSI
---------------------- Page: 4 ----------------------
5 ETSI GS NFV-SOL 005 V2.6.1 (2019-04)
5.4.9.3 Resource methods . 58
5.4.9.3.1 POST . 58
5.4.9.3.2 GET . 58
5.4.9.3.3 PUT . 59
5.4.9.3.4 PATCH . 59
5.4.9.3.5 DELETE . 59
5.4.10 Resource: Notification endpoint . 59
5.4.10.1 Description . 59
5.4.10.2 Resource definition . 60
5.4.10.3 Resource methods . 60
5.4.10.3.1 POST . 60
5.4.10.3.2 GET . 60
5.4.10.3.3 PUT . 61
5.4.10.3.4 PATCH . 61
5.4.10.3.5 DELETE . 61
5.5 Data model . 61
5.5.1 Introduction. 61
5.5.2 Resource and notification data types . 61
5.5.2.1 Type: NsdInfoModifications . 61
5.5.2.2 Type: NsdInfo . 62
5.5.2.3 Type: CreateNsdInfoRequest . 63
5.5.2.4 Type: PnfdInfoModifications . 63
5.5.2.5 Type: PnfdInfo . 63
5.5.2.6 Type: CreatePnfdInfoRequest . 64
5.5.2.7 Type: NsdmSubscriptionRequest . 64
5.5.2.8 Type: NsdmSubscription . 65
5.5.2.9 Type: NsdOnboardingNotification . 65
5.5.2.10 Type: NsdOnboardingFailureNotification . 66
5.5.2.11 Type: NsdChangeNotification. 66
5.5.2.12 Type: NsdDeletionNotification . 67
5.5.2.13 Type: PnfdOnboardingNotification . 67
5.5.2.14 Type: PnfdOnboardingFailureNotification . 67
5.5.2.15 Type: PnfdDeletionNotification . 68
5.5.3 Referenced structured data types . 68
5.5.3.1 Introduction . 68
5.5.3.2 Type: NsdmNotificationsFilter . 68
5.5.3.3 Type: NsdmLinks . 69
5.5.3.4 Type: PnfdmLinks . 70
5.5.4 Referenced simple data types and enumerations . 70
5.5.4.1 Introduction . 70
5.5.4.2 Simple data types . 70
5.5.4.3 Enumeration: NsdOperationalStateType . 70
5.5.4.4 Enumeration: NsdUsageStateType . 70
5.5.4.5 Enumeration: NsdOnboardingStateType . 71
5.5.4.6 Enumeration: PnfdOnboardingStateType . 71
5.5.4.7 Enumeration: PnfdUsageStateType . 71
6 NS Lifecycle Management interface . 71
6.1 Description . 71
6.1a API version . 72
6.2 Resource structure and methods . 72
6.3 Sequence diagrams (informative) . 74
6.3.1 Flow of the creation of a NS instance resource. 74
6.3.2 Flow of the deletion of a NS instance resource.
...