ETSI GS NFV-SOL 012 V3.4.1 (2020-10)

Network Functions Virtualisation (NFV) Release 3; Protocols and Data Models; RESTful protocols specification for the Policy Management Interface

DGS/NFV-SOL012ed341

General Information

• Status: Not Published
• Technical Committee: NFV SOL - Solutions
• Current Stage: 12 - Completion
• Due Date: 22-Nov-2020
• Completion Date: 26-Oct-2020

Standards Content (Sample)

ETSI GS NFV-SOL 012 V3.4.1 (2020-10)






GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 3;
Protocols and Data Models;
RESTful protocols specification for
the Policy Management Interface
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 012 V3.4.1 (2020-10)



Reference
DGS/NFV-SOL012ed341
Keywords
API, NFV, policy management

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 012 V3.4.1 (2020-10)
Contents
Intellectual Property Rights . 6
Foreword . 6
Modal verbs terminology . 6
1 Scope . 7
2 References . 7
2.1 Normative references . 7
2.2 Informative references . 8
3 Definition of terms, symbols and abbreviations . 8
3.1 Terms . 8
3.2 Symbols . 8
3.3 Abbreviations . 8
4 General aspects . 8
4.1 Overview . 8
4.2 Common data types . 9
5 Policy Management interface . 9
5.1 Description . 9
5.2 API version . 9
5.3 Resource structure and method . 10
5.4 Sequence diagrams (informative) . 11
5.4.1 Flow of creating a policy . 11
5.4.2 Flow of transferring a policy. 12
5.4.3 Flow of querying/reading policies . 13
5.4.4 Flow of fetching the content of a policy . 14
5.4.5 Flow of modifying a policy . 14
5.4.6 Flow of deleting a policy . 15
5.4.7 Flow of managing subscriptions . 16
5.4.8 Flow of sending notifications. 17
5.5 Resources . 18
5.5.1 Introduction. 18
5.5.2 Resource: API versions . 18
5.5.3 Resource: Policies . 18
5.5.3.1 Description . 18
5.5.3.2 Resource definition . 18
5.5.3.3 Resource methods . 19
5.5.3.3.1 POST . 19
5.5.3.3.2 GET . 19
5.5.3.3.3 PUT . 21
5.5.3.3.4 PATCH . 21
5.5.3.3.5 DELETE . 21
5.5.4 Resource: Individual policy . 21
5.5.4.1 Description . 21
5.5.4.2 Resource definition . 21
5.5.4.3 Resource methods . 21
5.5.4.3.1 POST . 21
5.5.4.3.2 GET . 21
5.5.4.3.3 PUT . 22
5.5.4.3.4 PATCH . 22
5.5.4.3.5 DELETE . 23
5.5.5 Resource: Selected version of an individual policy . 24
5.5.5.1 Description . 24
5.5.5.2 Resource definition . 24
5.5.5.3 Resource methods . 24
5.5.5.3.1 POST . 24
5.5.5.3.2 GET . 25
ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS NFV-SOL 012 V3.4.1 (2020-10)
5.5.5.3.3 PUT . 25
5.5.5.3.4 PATCH . 25
5.5.5.3.5 DELETE . 25
5.5.6 Resource: Particular version of an individual policy . 26
5.5.6.1 Description . 26
5.5.6.2 Resource definition . 26
5.5.6.3 Resource methods . 26
5.5.6.3.1 POST . 26
5.5.6.3.2 GET . 26
5.5.6.3.3 PUT . 27
5.5.6.3.4 PATCH . 28
5.5.6.3.5 DELETE . 28
5.5.7 Resource: Subscriptions . 28
5.5.7.1 Description . 28
5.5.7.2 Resource definition . 28
5.5.7.3 Resource methods . 29
5.5.7.3.1 POST . 29
5.5.7.3.2 GET . 30
5.5.7.3.3 PUT . 31
5.5.7.3.4 PATCH . 31
5.5.7.3.5 DELETE . 31
5.5.8 Resource: Individual subscription . 32
5.5.8.1 Description . 32
5.5.8.2 Resource definition . 32
5.5.8.3 Resource methods . 32
5.5.8.3.1 POST . 32
5.5.8.3.2 GET . 32
5.5.8.3.3 PUT . 33
5.5.8.3.4 PATCH . 33
5.5.8.3.5 DELETE . 33
5.5.9 Resource: Notification endpoint . 34
5.5.9.1 Description . 34
5.5.9.2 Resource definition . 34
5.5.9.3 Resource methods . 34
5.5.9.3.1 POST . 34
5.5.9.3.2 GET . 34
5.5.9.3.3 PUT . 35
5.5.9.3.4 PATCH . 35
5.5.9.3.5 DELETE . 35
5.6 Data model . 35
5.6.1 Introduction. 35
5.6.2 Resource and notification data types . 35
5.6.2.1 Introduction . 35
5.6.2.2 Type: CreatePolicyRequest . 35
5.6.2.3 Type: Policy . 37
5.6.2.4 Type: PolicyModifications . 37
5.6.2.5 Type: PolicySubscriptionRequest . 38
5.6.2.6 Type: PolicySubscription . 38
5.6.2.7 Type: PolicyChangeNotification . 39
5.6.2.8 Type: PolicyConflictNotification . 39
5.6.3 Referenced structured data types . 40
5.6.3.1 Introduction . 40
5.6.3.2 Type: PolicyNotificationsFilter . 40
5.6.4 Referenced simple data types and enumerations . 41
5.6.4.1 Introduction . 41
5.6.4.2 Simple data types . 41
5.6.4.3 Enumeration: ActivationStatus . 41
5.6.4.4 Enumeration: TransferStatus . 41
5.6.4.5 Enumeration: PolicyOperationType . 41
5.7 Policy management state model and error handling . 41
5.7.1 Introduction. 41
5.7.2 States and state transitions . 42
ETSI

---------------------- Page: 4 ----------------------
5 ETSI GS NFV-SOL 012 V3.4.1 (2020-10)
5.7.3 Handling of errors . 43
5.7.3.1 Failure during transfer of the policy content . 43
Annex A (informative): Mapping operations to protocol elements . 44
Annex B (informative): Change History . 45
History . 46


ETSI

---------------------- Page: 5 ----------------------
6 ETSI GS NFV-SOL 012 V3.4.1 (2020-10)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Foreword
This Group Specification (GS) has been produced by ETSI Industry Specification Group (ISG) Network Functions
Virtualisation (NFV).
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.

ETSI

---------------------- Page: 6 ----------------------
7 ETSI GS NFV-SOL 012 V3.4.1 (2020-10)
1 Scope
The present document specifies a RESTful protocol and data model fulfilling the requirements specified in the
following Group Specifications for the policy management interfaces used over the NFV-MANO reference points:
• ETSI GS NFV-IFA 005 [1]
• ETSI GS NFV-IFA 006 [2]
• ETSI GS NFV-IFA 007 [3]
• ETSI GS NFV-IFA 008 [4]
• ETSI GS NFV-IFA 013 [5]
• ETSI GS NFV-IFA 030 [6]
A data model for policy content is out of scope of the present document.
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] ETSI GS NFV-IFA 005: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; Or-Vi reference point - Interface and Information Model Specification".
[2] ETSI GS NFV-IFA 006: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; Vi-Vnfm reference point - Interface and Information Model Specification".
[3] ETSI GS NFV-IFA 007: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; Or-Vnfm reference point - Interface and Information Model Specification".
[4] ETSI GS NFV-IFA 008: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; Ve-Vnfm reference point - Interface and Information Model Specification".
[5] ETSI GS NFV-IFA 013: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; Os-Ma-Nfvo reference point - Interface and Information Model Specification".
[6] ETSI GS NFV-IFA 030: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; Multiple Administrative Domain Aspect Interfaces Specification".
[7] ETSI GS NFV-SOL 013: "Network Functions Virtualisation (NFV) Release 3; Protocols and Data
Models; Specification of common aspects for RESTful NFV MANO APIs".
ETSI

---------------------- Page: 7 ----------------------
8 ETSI GS NFV-SOL 012 V3.4.1 (2020-10)
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] ETSI GR NFV 003: "Network Functions Virtualisation (NFV); Terminology for Main Concepts in
NFV".
[i.2] ETSI GR NFV-IFA 023: "Network Functions Virtualisation (NFV); Management and
Orchestration; Report on Policy Management in MANO; Release 3".
3 Definition of terms, symbols and abbreviations
3.1 Terms
For the purposes of the present document, the terms given in ETSI GR NFV 003 [i.1] apply.
3.2 Symbols
Void.
3.3 Abbreviations
For the purposes of the present document, the abbreviations given in ETSI GR NFV 003 [i.1] and the following apply:
PF Policy Function
REST Representational State Transfer
URI Uniform Resource Identifier
4 General aspects
4.1 Overview
The present document defines the protocol and data model for the policy management interface used over the following
reference points, in the form of RESTful Application Programming Interfaces (APIs) specifications:
• Os-Ma-nfvo reference point (interface produced by the NFVO towards the OSS/BSS)
• Or-Vnfm reference point (interface produced by the VNFM towards the NFVO)
• Ve-Vnfm-em reference point (interface produced by the VNFM towards the EM)
• Or-Vi reference point (interface produced by the VIM towards the NFVO)
• Vi-Vnfm reference point (interface produced by the VIM towards the VNFM)
• Or-Or reference point (interface produced by NFVO-N towards NFVO-C)
ETSI

---------------------- Page: 8 ----------------------
9 ETSI GS NFV-SOL 012 V3.4.1 (2020-10)
The design of the protocol and data model for the policy management interface is based on the information model and
requirements defined in ETSI GS NFV-IFA 005 [1], ETSI GS NFV-IFA 006 [2], ETSI GS NFV-IFA 007 [3], ETSI
GS NFV-IFA 008 [4], ETSI GS NFV-IFA 013 [5] and ETSI GS NFV-IFA 030 [6].
In clause 4, general aspects are specified that apply to the policy management interface over different reference points.
In addition, the provisions in clauses 4, 5, 6, 8 and 9 of ETSI GS NFV-SOL 013 [7] define common aspects of RESTful
NFV-MANO APIs, and shall apply for all APIs defined in the present document.
In clause 5, the protocol and data model for the policy management interface is specified. The resource structure with
associated HTTP methods is defined and applicable flows are prov
...