ETSI GS NFV-SOL 002 V4.6.1 (2024-05)

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

RGS/NFV-SOL002ed461

General Information

• Status: Not Published
• Technical Committee: NFV SOL - Solutions
• Current Stage: 12 - Citation in the OJ (auto-insert)
• Due Date: 03-May-2024
• Completion Date: 06-May-2024

Standards Content (Sample)

GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 4;
Protocols and Data Models;
RESTful protocols specification
for the Ve-Vnfm 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 002 V4.6.1 (2024-05)

Reference
RGS/NFV-SOL002ed461
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:
https://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
If you find a security vulnerability in the present document, please report it through our
Coordinated Vulnerability Disclosure Program:
https://www.etsi.org/standards/coordinated-vulnerability-disclosure
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
rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
and/or governmental
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 2024.
All rights reserved.
ETSI
3 ETSI GS NFV-SOL 002 V4.6.1 (2024-05)
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 . 18
3 Definition of terms, symbols and abbreviations . 19
3.1 Terms . 19
3.2 Symbols . 20
3.3 Abbreviations . 20
4 General aspects . 21
4.1 Overview . 21
4.2 Void . 22
4.3 Void . 22
4.4 Common data types . 22
4.4.1 Structured data types . 22
4.4.1.1 Introduction . 22
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: VnfInstanceSubscriptionFilter . 22
4.4.1.6 Void. 23
4.4.2 Simple data types and enumerations . 23
4.4.2.1 Introduction . 23
4.4.2.2 Simple data types . 23
4.4.2.3 Enumerations . 23
4.4.2.3.1 Introduction . 23
4.4.2.3.2 Enumeration: LcmCoordResultType . 23
4.5 Void . 23
4.6 Void . 23
4.7 Void . 23
4.8 HTTP conditional requests . 24
5 VNF Lifecycle Management interface . 24
5.1 Description . 24
5.1a API version . 26
5.2 Resource structure and methods . 26
5.3 Sequence diagrams (informative) . 29
5.3.1 Flow of the creation of a VNF instance resource . 29
5.3.2 Flow of the deletion of a VNF instance resource . 30
5.3.3 Flow of VNF lifecycle management operations triggered by task resources . 30
5.3.4 Flow of automatic invocation of VNF scaling and VNF healing. 32
5.3.5 Flow of the Query VNF operation . 34
5.3.6 Flow of the Modify VNF Information operation . 35
5.3.7 Flow of the Get Operation Status operation . 37
5.3.8 Flow of managing subscriptions . 38
5.3.9 Flow of sending notifications. 39
5.3.10 Flow of retrying a VNF lifecycle management operation . 40
5.3.11 Flow of rolling back a VNF lifecycle management operation . 41
5.3.12 Flow of failing a VNF lifecycle management operation . 43
5.3.13 Flow of cancelling a VNF lifecycle management operation . 44
5.3.14 Flow of creation of a VNF snapshot resource . 46
5.3.15 Flow of the Query VNF Snapshot operation . 46
ETSI
4 ETSI GS NFV-SOL 002 V4.6.1 (2024-05)
5.3.16 Flow of the deletion of a VNF snapshot resource . 47
5.4 Resources . 47
5.4.1 Introduction. 47
5.4.1.1 Overview . 47
5.4.1.2 Task resources that trigger VNF LCM operations . 48
5.4.1a Resource: API versions . 49
5.4.2 Resource: VNF instances . 49
5.4.2.1 Description . 49
5.4.2.2 Resource definition . 50
5.4.2.3 Resource methods . 50
5.4.2.3.1 POST . 50
5.4.2.3.2 GET . 51
5.4.2.3.3 PUT . 52
5.4.2.3.4 PATCH . 53
5.4.2.3.5 DELETE . 53
5.4.3 Resource: Individual VNF instance . 53
5.4.3.1 Description . 53
5.4.3.2 Resource definition . 53
5.4.3.3 Resource methods . 53
5.4.3.3.1 POST . 53
5.4.3.3.2 GET . 53
5.4.3.3.3 PUT . 54
5.4.3.3.4 PATCH . 54
5.4.3.3.5 DELETE . 55
5.4.4 Resource: Instantiate VNF task . 56
5.4.4.1 Description . 56
5.4.4.2 Resource definition . 56
5.4.4.3 Resource methods . 56
5.4.4.3.1 POST . 56
5.4.4.3.2 GET . 57
5.4.4.3.3 PUT . 57
5.4.4.3.4 PATCH . 58
5.4.4.3.5 DELETE . 58
5.4.5 Resource: Scale VNF task . 58
5.4.5.1 Description . 58
5.4.5.2 Resource definition . 58
5.4.5.3 Resource methods . 58
5.4.5.3.1 POST . 58
5.4.5.3.2 GET . 59
5.4.5.3.3 PUT . 59
5.4.5.3.4 PATCH . 59
5.4.5.3.5 DELETE . 60
5.4.6 Resource: Scale VNF to Level task . 60
5.4.6.1 Description . 60
5.4.6.2 Resource definition . 60
5.4.6.3 Resource methods . 60
5.4.6.3.1 POST . 60
5.4.6.3.2 GET . 61
5.4.6.3.3 PUT . 61
5.4.6.3.4 PATCH . 61
5.4.6.3.5 DELETE . 62
5.4.7 Resource: Change VNF Flavour task . 62
5.4.7.1 Description . 62
5.4.7.2 Resource definition . 62
5.4.7.3 Resource methods . 62
5.4.7.3.1 POST . 62
5.4.7.3.2 GET . 64
5.4.7.3.3 PUT . 64
5.4.7.3.4 PATCH . 65
5.4.7.3.5 DELETE . 65
5.4.8 Resource: Terminate VNF task . 65
5.4.8.1 Description . 65
ETSI
5 ETSI GS NFV-SOL 002 V4.6.1 (2024-05)
5.4.8.2 Resource definition . 65
5.4.8.3 Resource methods . 65
5.4.8.3.1 POST . 65
5.4.8.3.2 GET . 66
5.4.8.3.3 PUT . 66
5.4.8.3.4 PATCH . 66
5.4.8.3.5 DELETE . 66
5.4.9 Resource: Heal VNF task . 66
5.4.9.1 Description . 66
5.4.9.2 Resource definition . 67
5.4.9.3 Resource methods . 67
5.4.9.3.1 POST . 67
5.4.9.3.2 GET . 68
5.4.9.3.3 PUT . 68
5.4.9.3.4 PATCH . 68
5.4.9.3.5 DELETE . 69
5.4.10 Resource: Operate VNF task . 69
5.4.10.1 Description . 69
5.4.10.2 Resource definition . 69
5.4.10.3 Resource methods . 69
5.4.10.3.1 POST . 69
5.4.10.3.2 GET . 70
5.4.10.3.3 PUT . 71
5.4.10.3.4 PATCH . 71
5.4.10.3.5 DELETE . 71
5.4.11 Resource: Change external VNF connectivity task . 71
5.4.11.1 Description . 71
5.4.11.2 Resource definition . 71
5.4.11.3 Resource methods . 72
5.4.11.3.1 POST . 72
5.4.11.3.2 GET . 72
5.4.11.3.3 PUT . 73
5.4.11.3.4 PATCH . 73
5.4.11.3.5 DELETE . 73
5.4.11a Resource: Change current VNF package task . 73
5.4.11a.1 Description . 73
5.4.11a.2 Resource definition . 74
5.4.11a.3 Resource methods . 74
5.4.11a.3.1 POST . 74
5.4.11a.3.2 GET . 76
5.4.11a.3.3 PUT . 76
5.4.11a.3.4 PATCH . 77
5.4.11a.3.5 DELETE . 77
5.4.11b Resource: Select VNF deployable modules task . 77
5.4.11b.1 Description . 77
5.4.11b.2 Resource definition . 77
5.4.11b.3 Resource methods . 77
5.4.11b.3.1 POST . 77
5.4.11b.3.2 GET . 78
5.4.11b.3.3 PUT . 78
5.4.11b.3.4 PATCH . 78
5.4.11b.3.5 DELETE . 79
5.4.12 Resource: VNF LCM operation occurrences . 79
5.4.12.1 Description . 79
5.4.12.2 Resource definition . 79
5.4.12.3 Resource methods . 79
5.4.12.3.1 POST . 79
5.4.12.3.2 GET . 79
5.4.12.3.3 PUT . 81
5.4.12.3.4 PATCH . 81
5.4.12.3.5 DELETE . 81
5.4.13 Resource: Individual VNF LCM operation occurrence . 82
ETSI
6 ETSI GS NFV-SOL 002 V4.6.1 (2024-05)
5.4.13.1 Description . 82
5.4.13.2 Resource definition . 82
5.4.13.3 Resource methods . 82
5.4.13.3.1 POST . 82
5.4.13.3.2 GET . 82
5.4.13.3.3 PUT . 83
5.4.13.3.4 PATCH . 83
5.4.13.3.5 DELETE . 83
5.4.14 Resource: Retry operation task . 83
5.4.14.1 Description . 83
5.4.14.2 Resource definition . 83
5.4.14.3 Resource methods . 84
5.4.14.3.1 POST . 84
5.4.14.3.2 GET . 85
5.4.14.3.3 PUT . 85
5.4.14.3.4 PATCH . 85
5.4.14.3.5 DELETE . 85
5.4.15 Resource: Rollback operation task . 85
5.4.15.1 Description . 85
5.4.15.2 Resource definition . 85
5.4.15.3 Resource methods . 85
5.4.15.3.1 POST . 85
5.4.15.3.2 GET . 86
5.4.15.3.3 PUT . 86
5.4.15.3.4 PATCH . 87
5.4.15.3.5 DELETE . 87
5.4.16 Resource: Fail operation task . 87
5.4.16.1 Description . 87
5.4.16.2 Resource definition . 87
5.4.16.3 Resource methods . 87
5.4.16.3.1 POST . 87
5.4.16.3.2 GET . 88
5.4.16.3.3 PUT . 88
5.4.16.3.4 PATCH . 88
5.4.16.3.5 DELETE . 88
5.4.17 Resource: Cancel operation task . 89
5.4.17.1 Description . 89
5.4.17.2 Resource definition . 89
5.4.17.3 Resource methods . 89
5.4.17.3.1 POST . 89
5.4.17.3.2 GET . 90
5.4.17.3.3 PUT . 90
5.4.17.3.4 PATCH . 90
5.4.17.3.5 DELETE . 90
5.4.18 Resource: Subscriptions . 91
5.4.18.1 Description . 91
5.4.18.2 Resource definition . 91
5.4.18.3 Resource methods . 91
5.4.18.3.1 POST . 91
5.4.18.3.2 GET . 92
5.4.18.3.3 PUT . 93
5.4.18.3.4 PATCH . 93
5.4.18.3.5 DELETE . 93
5.4.19 Resource: Individual subscription . 93
5.4.19.1 Description . 93
5.4.19.2 Resource definition . 94
5.4.19.3 Resource methods . 94
5.4.19.3.1 POST . 94
5.4.19.3.2 GET . 94
5.4.19.3.3 PUT . 94
5.4.19.3.4 PATCH . 94
5.4.19.3.5 DELETE . 95
ETSI
7 ETSI GS NFV-SOL 002 V4.6.1 (2024-05)
5.4.20 Resource: Notification endpoint . 95
5.4.20.1 Description . 95
5.4.20.2 Resource definition . 95
5.4.20.3 Resource methods . 95
5.4.20.3.1 POST . 95
5.4.20.3.2 GET . 96
5.4.20.3.3 PUT . 96
5.4.20.3.4 PATCH . 97
5.4.20.3.5 DELETE . 97
5.4.21 Resource: Create VNF snapshot task . 97
5.4.21.1 Description . 97
5.4.21.2 Resource definition .
...