|
GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 2;
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.
---------------------- Page: 1 ----------------------
2 ETSI GS NFV-SOL 002 V2.6.1 (2019-04)
Reference
RGS/NFV-SOL002ed261
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 002 V2.6.1 (2019-04)
Contents
Intellectual Property Rights . 14
Foreword . 14
Modal verbs terminology . 14
1 Scope . 15
2 References . 15
2.1 Normative references . 15
2.2 Informative references . 15
3 Definition of terms, symbols and abbreviations . 16
3.1 Terms . 16
3.2 Symbols . 16
3.3 Abbreviations . 16
4 General aspects . 17
4.1 Overview . 17
4.2 Void . 18
4.3 Void . 18
4.4 Common data types . 18
4.4.1 Structured data types . 18
4.4.1.1 Introduction . 18
4.4.1.2 Void. 18
4.4.1.3 Void. 18
4.4.1.3a Void. 18
4.4.1.4 Void. 18
4.4.1.5 Type: VnfInstanceSubscriptionFilter . 18
4.4.1.6 Type: ApiVersionInformation . 19
4.4.2 Simple data types and enumerations . 19
4.4.2.1 Introduction . 19
4.4.2.2 Simple data types . 19
4.4.2.3 Enumerations . 19
4.5 Void . 20
4.6 Void . 20
4.7 Void . 20
5 VNF Lifecycle Management interface . 20
5.1 Description . 20
5.1a API version . 21
5.2 Resource structure and methods . 21
5.3 Sequence diagrams (informative) . 23
5.3.1 Flow of the creation of a VNF instance resource . 23
5.3.2 Flow of the deletion of a VNF instance resource . 24
5.3.3 Flow of VNF lifecycle management operations triggered by task resources . 25
5.3.4 Flow of automatic invocation of VNF scaling and VNF healing. 28
5.3.5 Flow of the Query VNF operation . 30
5.3.6 Flow of the Modify VNF Information operation . 31
5.3.7 Flow of the Get Operation Status operation . 32
5.3.8 Flow of managing subscriptions . 33
5.3.9 Flow of sending notifications. 35
5.3.10 Flow of retrying a VNF lifecycle management operation . 36
5.3.11 Flow of rolling back a VNF lifecycle management operation . 37
5.3.12 Flow of failing a VNF lifecycle management operation . 38
5.3.13 Flow of cancelling a VNF lifecycle management operation . 39
5.4 Resources . 41
5.4.1 Introduction. 41
5.4.1a Resource: API versions . 41
5.4.2 Resource: VNF instances . 42
5.4.2.1 Description . 42
ETSI
---------------------- Page: 3 ----------------------
4 ETSI GS NFV-SOL 002 V2.6.1 (2019-04)
5.4.2.2 Resource definition . 42
5.4.2.3 Resource methods . 42
5.4.2.3.1 POST . 42
5.4.2.3.2 GET . 42
5.4.2.3.3 PUT . 43
5.4.2.3.4 PATCH . 43
5.4.2.3.5 DELETE . 43
5.4.3 Resource: Individual VNF instance . 44
5.4.3.1 Description . 44
5.4.3.2 Resource definition . 44
5.4.3.3 Resource methods . 44
5.4.3.3.1 POST . 44
5.4.3.3.2 GET . 44
5.4.3.3.3 PUT . 45
5.4.3.3.4 PATCH . 45
5.4.3.3.5 DELETE . 45
5.4.4 Resource: Instantiate VNF task . 46
5.4.4.1 Description . 46
5.4.4.2 Resource definition . 46
5.4.4.3 Resource methods . 46
5.4.4.3.1 POST . 46
5.4.4.3.2 GET . 47
5.4.4.3.3 PUT . 47
5.4.4.3.4 PATCH . 47
5.4.4.3.5 DELETE . 47
5.4.5 Resource: Scale VNF task . 47
5.4.5.1 Description . 47
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 . 49
5.4.5.3.4 PATCH . 49
5.4.5.3.5 DELETE . 49
5.4.6 Resource: Scale VNF to Level task . 50
5.4.6.1 Description . 50
5.4.6.2 Resource definition . 50
5.4.6.3 Resource methods . 50
5.4.6.3.1 POST . 50
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 . 51
5.4.7 Resource: Change VNF Flavour task . 52
5.4.7.1 Description . 52
5.4.7.2 Resource definition . 52
5.4.7.3 Resource methods . 52
5.4.7.3.1 POST . 52
5.4.7.3.2 GET . 53
5.4.7.3.3 PUT . 53
5.4.7.3.4 PATCH . 53
5.4.7.3.5 DELETE . 53
5.4.8 Resource: Terminate VNF task . 54
5.4.8.1 Description . 54
5.4.8.2 Resource definition . 54
5.4.8.3 Resource methods . 54
5.4.8.3.1 POST . 54
5.4.8.3.2 GET . 55
5.4.8.3.3 PUT . 55
5.4.8.3.4 PATCH . 55
5.4.8.3.5 DELETE . 55
5.4.9 Resource: Heal VNF task . 55
ETSI
---------------------- Page: 4 ----------------------
5 ETSI GS NFV-SOL 002 V2.6.1 (2019-04)
5.4.9.1 Description . 55
5.4.9.2 Resource definition . 55
5.4.9.3 Resource methods . 56
5.4.9.3.1 POST . 56
5.4.9.3.2 GET . 57
5.4.9.3.3 PUT . 57
5.4.9.3.4 PATCH . 57
5.4.9.3.5 DELETE . 57
5.4.10 Resource: Operate VNF task . 58
5.4.10.1 Description . 58
5.4.10.2 Resource definition . 58
5.4.10.3 Resource methods . 58
5.4.10.3.1 POST . 58
5.4.10.3.2 GET . 59
5.4.10.3.3 PUT . 59
5.4.10.3.4 PATCH . 59
5.4.10.3.5 DELETE . 59
5.4.11 Resource: Change external VNF connectivity task . 60
5.4.11.1 Description . 60
5.4.11.2 Resource definition . 60
5.4.11.3 Resource methods . 60
5.4.11.3.1 POST . 60
5.4.11.3.2 GET . 61
5.4.11.3.3 PUT . 61
5.4.11.3.4 PATCH . 61
5.4.11.3.5 DELETE . 61
5.4.12 Resource: VNF LCM operation occurrences . 61
5.4.12.1 Description . 61
5.4.12.2 Resource definition . 61
5.4.12.3 Resource methods . 62
5.4.12.3.1 POST . 62
5.4.12.3.2 GET . 62
5.4.12.3.3 PUT . 63
5.4.12.3.4 PATCH . 63
5.4.12.3.5 DELETE . 63
5.4.13 Resource: Individual VNF LCM operation occurrence . 63
5.4.13.1 Description . 63
5.4.13.2 Resource definition . 64
5.4.13.3 Resource methods . 64
5.4.13.3.1 POST . 64
5.4.13.3.2 GET . 64
5.4.13.3.3 PUT . 64
5.4.13.3.4 PATCH . 65
5.4.13.3.5 DELETE . 65
5.4.14 Resource: Retry operation task . 65
5.4.14.1 Description . 65
5.4.14.2 Resource definition . 65
5.4.14.3 Resource methods . 65
5.4.14.3.1 POST . 65
5.4.14.3.2 GET . 66
5.4.14.3.3 PUT . 66
5.4.14.3.4 PATCH .
...