ETSI GS NFV-SOL 005 V3.6.1 (2022-02)

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

RGS/NFV-SOL005ed361

General Information

• Status: Not Published
• Technical Committee: NFV SOL - Solutions
• Current Stage: 12 - Completion
• Due Date: 15-Feb-2022
• Completion Date: 10-Feb-2022

Standards Content (Sample)

GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 3;
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.

2 ETSI GS NFV-SOL 005 V3.6.1 (2022-02)

Reference
RGS/NFV-SOL005ed361
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 - 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:
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
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 2022.
All rights reserved.
ETSI
3 ETSI GS NFV-SOL 005 V3.6.1 (2022-02)
Contents
Intellectual Property Rights . 24
Foreword . 24
Modal verbs terminology . 24
1 Scope . 25
2 References . 25
2.1 Normative references . 25
2.2 Informative references . 27
3 Definition of terms, symbols and abbreviations . 27
3.1 Terms . 27
3.2 Symbols . 27
3.3 Abbreviations . 28
4 General Aspects . 29
4.1 Overview . 29
4.2 Void . 30
4.3 Void . 30
4.4 Common data types . 30
4.4.1 Structured data types . 30
4.4.1.1 Introduction . 30
4.4.1.2 Void. 30
4.4.1.3 Void. 30
4.4.1.3a Void. 30
4.4.1.4 Void. 30
4.4.1.5 Type: NsInstanceSubscriptionFilter . 30
4.4.1.6 Type: ResourceHandle . 31
4.4.1.7 Void. 32
4.4.2 Simple data types and enumerations . 32
4.4.2.1 Introduction . 32
4.4.2.2 Simple data types . 32
4.4.2.3 Enumerations . 32
4.5 Void . 32
4.6 Void . 32
4.7 Void . 32
5 NSD Management interface . 32
5.1 Description . 32
5.1a API version . 33
5.2 Resource structure and methods . 33
5.3 Sequence diagrams (informative) . 36
5.3.1 Flow of the creation of an individual NS descriptor resource . 36
5.3.2 Flow of the uploading of NSD archive content . 37
5.3.3 Flow of the fetching of an onboarded NSD archive . 38
5.3.4 Flow of the update of an individual NS descriptor resource . 39
5.3.5 Flow of the deletion of an individual NS descriptor resource . 40
5.3.6 Flow of the querying/reading of NS descriptor information . 41
5.3.6a Flow of reading the NSD . 42
5.3.6b Flow of fetching the manifest file of an onboarded NSD archive. 42
5.3.6c Flow of fetching an NSD archive artifact . 43
5.3.7 Flow of the creation of an individual PNF descriptor resource . 44
5.3.8 Flow of the uploading of PNFD archive . 44
5.3.9 Flow of the fetching of an onboarded PNFD archive . 45
5.3.9a Flow of the update of an individual PNF descriptor resource . 46
5.3.10 Flow of the deletion of an individual PNF descriptor resource . 46
5.3.11 Flow of the querying/reading of PNF descriptor information . 47
5.3.11a Flow of reading the PNFD . 49
5.3.11b Flow of fetching the manifest file of an onboarded PNFD archive . 49
ETSI
4 ETSI GS NFV-SOL 005 V3.6.1 (2022-02)
5.3.11c Flow of fetching a PNFD archive artifact . 50
5.3.12 Flow of managing subscriptions . 50
5.3.13 Flow of sending notifications. 52
5.4 Resources . 53
5.4.1 Introduction. 53
5.4.1a Resource: API versions . 53
5.4.2 Resource: NS Descriptors . 53
5.4.2.1 Description . 53
5.4.2.2 Resource definition . 53
5.4.2.3 Resource methods . 54
5.4.2.3.1 POST . 54
5.4.2.3.2 GET . 54
5.4.2.3.3 PUT . 55
5.4.2.3.4 PATCH . 56
5.4.2.3.5 DELETE . 56
5.4.3 Resource: Individual NS Descriptor . 56
5.4.3.1 Description . 56
5.4.3.2 Resource definition . 56
5.4.3.3 Resource methods . 56
5.4.3.3.1 POST . 56
5.4.3.3.2 GET . 56
5.4.3.3.3 PUT . 57
5.4.3.3.4 PATCH . 57
5.4.3.3.5 DELETE . 58
5.4.4 Resource: NSD archive content . 59
5.4.4.1 Description . 59
5.4.4.2 Resource definition . 59
5.4.4.3 Resource methods . 60
5.4.4.3.1 POST . 60
5.4.4.3.2 GET . 60
5.4.4.3.3 PUT . 61
5.4.4.3.4 PATCH . 62
5.4.4.3.5 DELETE . 62
5.4.4a Resource: NSD . 62
5.4.4a.1 Description . 62
5.4.4a.2 Resource definition . 63
5.4.4a.3 Resource methods . 63
5.4.4a.3.1 POST . 63
5.4.4a.3.2 GET . 63
5.4.4a.3.3 PUT . 65
5.4.4a.3.4 PATCH . 65
5.4.4a.3.5 DELETE . 65
5.4.4b Resource: NSD archive manifest . 65
5.4.4b.1 Description . 65
5.4.4b.2 Resource definition . 65
5.4.4b.3 Resource methods . 65
5.4.4b.3.1 POST . 65
5.4.4b.3.2 GET . 65
5.4.4b.3.3 PUT . 66
5.4.4b.3.4 PATCH . 67
5.4.4b.3.5 DELETE . 67
5.4.4c Resource: Individual NSD archive artifact . 67
5.4.4c.1 Description . 67
5.4.4c.2 Resource definition . 67
5.4.4c.3 Resource methods . 67
5.4.4c.3.1 POST . 67
5.4.4c.3.2 GET . 68
5.4.4c.3.3 PUT . 69
5.4.4c.3.4 PATCH . 69
5.4.4c.3.5 DELETE . 69
5.4.5 Resource: PNF Descriptors . 70
5.4.5.1 Description . 70
ETSI
5 ETSI GS NFV-SOL 005 V3.6.1 (2022-02)
5.4.5.2 Resource definition . 70
5.4.5.3 Resource methods . 70
5.4.5.3.1 POST . 70
5.4.5.3.2 GET . 71
5.4.5.3.3 PUT . 72
5.4.5.3.4 PATCH . 72
5.4.5.3.5 DELETE . 72
5.4.6 Resource: Individual PNF Descriptor . 73
5.4.6.1 Description . 73
5.4.6.2 Resource definition . 73
5.4.6.3 Resource methods . 73
5.4.6.3.1 POST . 73
5.4.6.3.2 GET . 73
5.4.6.3.3 PUT . 74
5.4.6.3.4 PATCH . 74
5.4.6.3.5 DELETE . 74
5.4.7 Resource: PNFD archive content . 75
5.4.7.1 Description . 75
5.4.7.2 Resource definition . 75
5.4.7.3 Resource methods . 75
5.4.7.3.1 POST . 75
5.4.7.3.2 GET . 76
5.4.7.3.3 PUT . 77
5.4.7.3.4 PATCH . 78
5.4.7.3.5 DELETE . 78
5.4.7a Resource: PNFD . 78
5.4.7a.1 Description . 78
5.4.7a.2 Resource definition . 78
5.4.7a.3 Resource methods . 78
5.4.7a.3.1 POST . 78
5.4.7a.3.2 GET . 78
5.4.7a.3.3 PUT . 80
5.4.7a.3.4 PATCH . 80
5.4.7a.3.5 DELETE . 80
5.4.7b Resource: PNFD archive manifest . 80
5.4.7b.1 Description . 80
5.4.7b.2 Resource definition . 81
5.4.7b.3 Resource methods . 81
5.4.7b.3.1 POST . 81
5.4.7b.3.2 GET . 81
5.4.7b.3.3 PUT . 82
5.4.7b.3.4 PATCH . 82
5.4.7b.3.5 DELETE . 82
5.4.7c Resource: Individual PNFD archive artifact . 83
5.4.7c.1 Description . 83
5.4.7c.2 Resource definition . 83
5.4.7c.3 Resource methods . 83
5.4.7c.3.1 POST . 83
5.4.7c.3.2 GET . 83
5.4.7c.3.3 PUT . 85
5.4.7c.3.4 PATCH . 85
5.4.7c.3.5 DELETE . 85
5.4.8 Resource: Subscriptions . 85
5.4.8.1 Description . 85
5.4.8.2 Resource definition . 85
5.4.8.3 Resource methods . 86
5.4.8.3.1 POST . 86
5.4.8.3.2 GET . 87
5.4.8.3.3 PUT . 88
5.4.8.3.4 PATCH . 89
5.4.8.3.5 DELETE . 89
5.4.9 Resource: Individual subscription . 89
ETSI
6 ETSI GS NFV-SOL 005 V3.6.1 (2022-02)
5.4.9.1 Description . 89
5.4.9.2 Resource definition . 89
5.4.9.3 Resource methods . 89
5.4.9.3.1 POST . 89
5.4.9.3.2 GET . 89
5.4.9.3.3 PUT . 90
5.4.9.3.4 PATCH . 90
5.4.9.3.5 DELETE . 90
5.4.10 Resource: Notification endpoint . 90
5.4.10.1 Description . 90
5.4.10.2 Resource definition . 91
5.4.10.3 Resource methods . 91
5.4.10.3.1 POST . 91
5.4.10.3.2 GET . 91
5.4.10.3.3 PUT . 92
5.4.10.3.4 PATCH . 92
5.4.10.3.5 DELETE . 92
5.5 Data model . 92
5.5.1 Introduction. 92
5.5.2 Resource and notification data types . 92
5.5.2.1 Type: NsdInfoModifications . 92
5.5.2.2 Type: NsdInfo . 93
5.5.2.3 Type: CreateNsdInfoRequest . 94
5.5.2.4 Type: PnfdInfoModifications . 94
5.5.2.5 Type: PnfdInfo . 95
5.5.2.6 Type: CreatePnfdInfoRequest . 96
5.5.2.7 Type: NsdmSubscriptionRequest . 96
5.5.2.8 Type: NsdmSubscription . 96
5.5.2.9 Type: NsdOnboardingNotification . 97
5.5.2.10 Type: NsdOnboardingFailureNotification . 97
5.5.2.11 Type: NsdChangeNotification. 98
5.5.2.12 Type: NsdDeletionNotification . 98
5.5.2.13 Type: PnfdOnboardingNotification . 99
5.5.2.14 Type: PnfdOnboardingFailureNotification . 99
5.5.2.15 Type: PnfdDeletionNotification . 99
5.5.3 Referenced structured data types . 100
5.5.3.1 Introduction . 100
5.5.3.2 Type: NsdmNotificationsFilter . 100
5.5.3.3 Type: NsdmLinks . 101
5.5.3.4 Type: PnfdmLinks . 101
5.5.3.5 Type: NsdArchiveArtifactInfo . 101
5.5.3.6 Type: PnfdArchiveArtifactInfo . 102
5.5.4 Referenced simple data types and enumerations . 102
5.5.4.1 Introduction . 102
5.5.4.2 Simple data types . 102
5.5.4.3 Enumeration: NsdOperationalStateType . 102
5.5.4.4 Enumeration: NsdUsageStateType . 102
5.5.4.5 Enumeration: NsdOnboardingStateType . 103
5.5.4.6 Enumeration: PnfdOnboardingStateType . 103
5.5.4.7 Enumeration: PnfdUsageStateType . 103
6 NS Lifecycle Management interface . 103
6.1 Description . 103
6.1a API version . 104
6.2 Resource structure and methods . 104
6.3 Sequence diagrams (informative) . 107
6.3.1 Flow of the creation of an NS instance resource . 107
6.3.2 Flow of the deletion of an NS instance resource. 107
6.3.3 Flow of NS lifecycle management operations triggered by task resources. 108
6.3.3a Flows of NS lifecycle management operations triggered by task resources with pre-emption . 110
6.3.3a.1 Overview . 110
6.3.3a.2 Steps shared by multiple flows . 111
ETSI
7 ETSI GS NFV-SOL 005 V3.6.1 (2022-02)
6.3.3a.3 Shortage Use Case #1. 112
6.3.3a.4 Shortage Use Case #2. 114
6.3.3a.5 Shortage Use Case #3. 117
6.3.3a.6 Shortage Use Case #4. 121
6.3.4 Flow of the get operations status operation . 122
6.3.5 Flow of managing subscriptions . 123
6.3.6 Flow of sending notifications. 124
6.3.7 Flow of retrying an NS lifecycle management operation . 125
6.3.8 Flow of rolling back an NS lifecycle management operation . 126
6.3.9 Flow of continuing an NS lifecycle management operation . 128
6.3.10 Flow of failing an NS lifecycle management operation . 129
6.3.11 Flow of cancelling an NS lifecycle management operation . 130
6.3.12 Flow of the query VNF snapshot operation . 131
6.3.13 Flow of the deletion of a VNF snapshot resource . 131
6.4 Resources . 132
6.4.1 Introduction. 132
6.4.1.1 Overview . 132
6.4.1.2 Task resources that trigger NS LCM operations .
...