Difference between revisions of "API specifications"

From NFVwiki
Jump to: navigation, search
(OpenAPIs)
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== API conventions==
 
== API conventions==
 
+
[https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/015/ ETSI GS NFV-SOL 015] defines patterns and conventions for RESTful NFV-MANO API specifications, gives recommendations on API versioning and provides an API specification template. This GS defines provisions to be followed by the ETSI NFV Industry Specification Group (ISG) when creating RESTful NFV-MANO API specifications. The provisions do not apply to implementations.
*[https://nfvwiki.etsi.org/images/NFVSOL%2817%29000050r4_ETSI_NFV_SOL_REST_API_Conventions.pdf ETSI NFV SOL API Conventions]
 
*[https://nfvwiki.etsi.org/index.php?title=OpenAPIs_development_guidelines OpenAPI developement guidelines]
 
  
 
== API specifications ==
 
== API specifications ==
  
 
  {| class="wikitable alternance center"
 
  {| class="wikitable alternance center"
  |+ APIs exposed on MANO reference points
+
  |+ ETSI NFV Management and Orchestration (NFV-MANO) Core APIs  
 
  |-
 
  |-
 
  |
 
  |
 
  ! scope="col" | APIs  
 
  ! scope="col" | APIs  
  ! scope="col" | Latest Published Version v2.3.1
+
  ! scope="col" | Published Versions
! scope="col" | Latest Drafts
 
 
  ! scope="col" | Bug Tracker
 
  ! scope="col" | Bug Tracker
! scope="col" | Draft OpenAPI
 
  
 
  |-
 
  |-
  ! scope="row" | Ve-Vnfm  <br> (NFV-SOL 002)
+
  ! scope="row" | NFV-SOL 002
  | align = "left" |  
+
(Ve-Vnfm)   <br>
 +
  | align="left" |  
 
VNF Lifecycle Management interface (as produced by the VNFM towards the EM/VNF)
 
VNF Lifecycle Management interface (as produced by the VNFM towards the EM/VNF)
  
Line 29: Line 26:
 
VNF Configuration interface (as produced by the VNF towards the VNFM)
 
VNF Configuration interface (as produced by the VNF towards the VNFM)
  
This specification fulfills the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/008/02.01.01_60/gs_NFV-IFA008v020101p.pdf ETSI GS NFV-IFA 008]
+
VNF LCM Coordination interface (as produced by the VNF/EM) - Release 3 only
 +
 
 +
VNFC Snapshot Package Management interface (as produced by the VNFM) - Release 3 only
 +
 
 +
This specification fulfils the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/008/ ETSI GS NFV-IFA 008]
  
  | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.03.01_60/gs_NFV-SOL002v020301p.pdf Published specification]
+
  | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/ Published specifications]
| [https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL002ed241_Ve-Vnfm_RESTful_protocols_spec Draft]
 
 
  | [http://forge.etsi.org/mantis/set_project.php?project_id=153;217&make_default=no&ref=view_all_bug_page.php Issue Tracker]  
 
  | [http://forge.etsi.org/mantis/set_project.php?project_id=153;217&make_default=no&ref=view_all_bug_page.php Issue Tracker]  
| [https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL002-SOL003.git/tree/HEAD:/src/SOL002 Git repository]
 
 
  |-
 
  |-
  ! scope="row" | Or-Vnfm  <br>    (NFV-SOL 003)
+
  ! scope="row" | NFV-SOL 003
  | align = "left" |  
+
(Or-Vnfm)
 +
  | align="left" |  
 
VNF Lifecycle Management interface (as produced by the VNFM towards the NFVO).
 
VNF Lifecycle Management interface (as produced by the VNFM towards the NFVO).
  
Line 52: Line 52:
 
Virtualised Resources Quota Available Notification interface (as produced by the NFVO towards the VNFM).
 
Virtualised Resources Quota Available Notification interface (as produced by the NFVO towards the VNFM).
  
This specification fulfills the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/007/02.01.01_60/gs_NFV-IFA007v020101p.pdf ETSI GS NFV-IFA 007]
+
VNF Snapshot Package Management interface (as produced by  the VNFM) - Release 3 only
 +
 
 +
This specification fulfils the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/007/ ETSI GS NFV-IFA 007]
  
  | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.03.01_60/gs_NFV-SOL003v020301p.pdf Published specification]
+
  | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/ Published specifications]
| [https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL003ed241_Or-Vnfm_RESTful_protocols_spec Draft]
 
 
  | [http://forge.etsi.org/mantis/set_project.php?project_id=153;218&make_default=no&ref=view_all_bug_page.php Issue Tracker]  
 
  | [http://forge.etsi.org/mantis/set_project.php?project_id=153;218&make_default=no&ref=view_all_bug_page.php Issue Tracker]  
| [https://forge.etsi.org/rep/gitweb.cgi/NFV-SOL002-SOL003.git/tree/HEAD:/src/SOL003 Git repository]
 
 
  |-
 
  |-
  ! scope="row" | Os-Ma-Nfvo  <br>   (NFV-SOL 005)
+
  ! scope="row" | NFV-SOL 005
  | align = "left" |  
+
(Os-Ma-Nfvo)   <br>
 +
  | align="left" |  
 
NSD Management interface (as produced by the NFVO towards the OSS/BSS)
 
NSD Management interface (as produced by the NFVO towards the OSS/BSS)
  
Line 71: Line 72:
 
VNF Package Management interface (as produced by the NFVO towards the OSS/BSS)
 
VNF Package Management interface (as produced by the NFVO towards the OSS/BSS)
  
This specification fulfills the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/013/02.01.01_60/gs_NFV-IFA013v020101p.pdf ETSI GS NFV-IFA 013]
+
NFVI Capacity Information interface (as produced by the NFVO) - Release 3 only
| Not Applicable
+
 
  | [https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL005_Os-Ma-nfvo_APIs Draft]
+
VNF Snapshot Package Management interface (as produced by the NFVO) - Release 3 only
 +
 
 +
LCM Coordination interface (as produced by the OSS/BSS) - Release 3 only
 +
 
 +
This specification fulfils the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/013/ ETSI GS NFV-IFA 013]
 +
  | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/ Published specifications]
 
  | [http://forge.etsi.org/mantis/set_project.php?project_id=153;227&make_default=no&ref=view_all_bug_page.php Issue Tracker]
 
  | [http://forge.etsi.org/mantis/set_project.php?project_id=153;227&make_default=no&ref=view_all_bug_page.php Issue Tracker]
| Work In Progress
 
  
 
  |}
 
  |}
 +
Note that [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/013/ ETSI GS NFV-SOL 013] and [https://www.etsi.org/deliver/etsi_gs/NFV-SEC/001_099/022/ ETSI GS NFV-SEC 022] complement the aforementioned specifications with common procedures (e.g. version management) and security aspects, respectively.
  
== Tutorials ==
+
Draft specifications under development are available at https://docbox.etsi.org/ISG/NFV/Open/Drafts
 +
 
 +
{| class="wikitable alternance center"
 +
|+ Other ETSI NFV Management and Orchestration (NFV-MANO) APIs
 +
|-
 +
|
 +
! scope="col" | APIs
 +
! scope="col" | Published Versions
 +
! scope="col" | Bug Tracker
 +
 
 +
|-
 +
! scope="row" | NFV-SOL 009
 +
(MANO management)  <br>
 +
| align="left" |
 +
NFV-MANO configuration and information management interface
 +
 
 +
NFV-MANO performance management interface
 +
 
 +
NFV-MANO Fault Management interface
 +
 
 +
NFV-MANO log management interface
 +
 
 +
This specification fulfils the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/031/ ETSI GS NFV-IFA 031]
 +
 
 +
| [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/ Published specifications]
 +
| [http://tinyurl.com/t9dhvpq Issue Tracker]
 +
|-
 +
! scope="row" | NFV-SOL 011
 +
(Or-Or) 
 +
| align="left" |
 +
VNF Lifecycle Management interface (as produced by the VNFM towards the NFVO).
 +
 
 +
VNF Performance Management interface (as produced by the VNFM towards the NFVO).
 +
 
 +
VNF Fault Management interface (as produced by the VNFM towards the NFVO).
 +
 
 +
VNF Indicator interface (as produced by the VNFM towards the NFVO).
 +
 
 +
VNF Lifecycle Operation Granting interface (as produced by the NFVO towards the VNFM).
 +
 
 +
VNF Package Management interface (as produced by the NFVO towards the VNFM).
 +
 
 +
Virtualised Resources Quota Available Notification interface (as produced by the NFVO towards the VNFM).
 +
 
 +
This specification fulfils the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/007/ ETSI GS NFV-IFA 011]
 +
 
 +
| [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf Published specifications]
 +
| [http://tinyurl.com/wgdrdb6 Issue Tracker]
 +
|-
 +
! scope="row" | NFV-SOL 012
 +
(Policy Management)  <br>
 +
| align="left" |
 +
Policy Management interface
 +
 
 +
| [https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL012ed331_Protocol_Spec_for_Policy_Mgmt_Intface Draft available]
 +
| [http://oldforge.etsi.org/mantis/search.php?project_id=256&sticky_issues=off&sortby=last_updated&dir=DESC&hide_status_id=-2&match_type=0 Issue Tracker]
  
Links to tutorials and webinars
+
|}
 +
Note that [https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/013/ ETSI GS NFV-SOL 013] and [https://www.etsi.org/deliver/etsi_gs/NFV-SEC/001_099/022/ ETSI GS NFV-SEC 022] complement the aforementioned specifications with common procedures (e.g. version management) and security aspects, respectively.
  
*[https://www.brighttalk.com/webcast/6985/263719/common-api-for-nfv-interop  Webinar on APIs for interoperability]
+
Draft specifications under development are available at https://docbox.etsi.org/ISG/NFV/Open/Drafts
*[https://play.webvideocore.net/popplayer.php?it=6dq6y2ugg9c8&c1=%23c8c8c8&c2=%23a6a6a6&w=720&h=505&p=0&title=123LIVE%21+%3A+Common+API+for+NFV+%7C+Bruno+Chatras+%7C+Orange Tutorial at SDN NFV World Congress, Nov 2017]
 
  
 
== OpenAPIs ==
 
== OpenAPIs ==
 +
For each of the APIs specified in the aforementionned documents, an OpenAPI representation is made available on the ETSI Forge Server. These representations, along with developement guidelines, can be found [[SOL OpenAPI Main Page|here]].
  
<center>
+
== Conformance testing ==
<big>
+
Conformance tests for APIs are specified in [https://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/010/ ETSI GS NFV-TST 010]. The Robot code for all test cases is available on the [https://forge.etsi.org/rep/nfv/ ETSI Forge]
IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence.
 
  
If you found a discrepancy between the NFV Specifications and their OpenAPI description, please report it
+
== Tutorials ==
[https://forge.etsi.org/bugzilla/enter_bug.cgi?product=NFV here.]
 
</big>
 
</center>
 
  
How to use the links:
+
Links to tutorials and webinars
* The '''PDF''' column contains links to the '''PDF export of the API definition'''.
 
* '''YAML''' and '''JSON''' columns contain links to the '''raw text files'''. They will open a page in the browser with a lot of non readable text and they are meant to be downloaded or used as input for other tools;
 
* The '''UI''' column contains links to the graphical view of the interface using the Swagger UI tool hosted at the Forge. If you want to know more about the Swagger UI tool [https://swagger.io/swagger-ui/ click here].
 
* The '''EDITOR''' column contains links to a window with both the textual and the graphical views of the interface using the Swagger Editor tool hosted at the Forge. If you want to know more about the Swagger Editor tool [https://swagger.io/swagger-editor/ click here].
 
  
<big>
+
*[https://www.brighttalk.com/webcast/6985/263719/common-api-for-nfv-interop Webinar on APIs for interoperability]
{| class="wikitable sortable center"
+
*[https://play.webvideocore.net/popplayer.php?it=6dq6y2ugg9c8&c1=%23c8c8c8&c2=%23a6a6a6&w=720&h=505&p=0&title=123LIVE%21+%3A+Common+API+for+NFV+%7C+Bruno+Chatras+%7C+Orange Tutorial at SDN NFV World Congress, Nov 2017]
! Interface
 
! Ref Point
 
! Producer
 
! PDF
 
! YAML
 
! JSON
 
! UI
 
! EDITOR
 
|-
 
| style="text-align:left;" | VNF Configuration API
 
| SOL002
 
| VNF
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFConfiguration-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Indicator API
 
| SOL002
 
| VNF/EM
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicator-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF IndicatorNotification API
 
| SOL002
 
| VNFM
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL002-VNFIndicatorNotification-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | Virtualised Resources Quota Available Notification API
 
| SOL003
 
| NFVO
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VirtualisedResourcesQuotaAvailableNotification-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Fault Management API
 
| SOL003
 
| VNFM
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagement-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Fault Management Notification API
 
| SOL003
 
| NFVO
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFFaultManagementNotification-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Indicator API
 
| SOL003
 
| VNFM
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicator-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Indicator Notification API
 
| SOL003
 
| NFVO
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFIndicatorNotification-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Lifecycle Management API
 
| SOL003
 
| VNFM
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleManagement-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Lifecycle Operation Granting API
 
| SOL003
 
| NFVO
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFLifecycleOperationGranting-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Package Management API
 
| SOL003
 
| NFVO
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagement-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Package Management Notification API
 
| SOL003
 
| VNFM
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPackageManagementNotification-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Performance Management API
 
| SOL003
 
| VNFM
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagement-API.yaml/*view*/ Link]
 
|-
 
| style="text-align:left;" | VNF Performance Management Notification API
 
| SOL003
 
| NFVO
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.pdf Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.json/*view*/ Link]
 
| [https://forge.etsi.org/swagger/ui?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.yaml/*view*/ Link]
 
| [https://forge.etsi.org/swagger/editor?url=https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/lastSuccessfulBuild/artifact/build/SOL003-VNFPerformanceManagementNotification-API.yaml/*view*/ Link]
 
|}
 
</big>
 
  
 
== Link ==
 
== Link ==

Latest revision as of 12:43, 8 April 2020

API conventions

ETSI GS NFV-SOL 015 defines patterns and conventions for RESTful NFV-MANO API specifications, gives recommendations on API versioning and provides an API specification template. This GS defines provisions to be followed by the ETSI NFV Industry Specification Group (ISG) when creating RESTful NFV-MANO API specifications. The provisions do not apply to implementations.

API specifications

ETSI NFV Management and Orchestration (NFV-MANO) Core APIs
APIs Published Versions Bug Tracker
NFV-SOL 002

(Ve-Vnfm)

VNF Lifecycle Management interface (as produced by the VNFM towards the EM/VNF)

VNF Performance Management interface (as produced by the VNFM towards the EM)

VNF Fault Management interface (as produced by the VNFM towards the EM)

VNF Indicator interface (as produced by the EM/VNF towards the VNFM)

VNF Configuration interface (as produced by the VNF towards the VNFM)

VNF LCM Coordination interface (as produced by the VNF/EM) - Release 3 only

VNFC Snapshot Package Management interface (as produced by the VNFM) - Release 3 only

This specification fulfils the requirements specified in ETSI GS NFV-IFA 008

Published specifications Issue Tracker
NFV-SOL 003

(Or-Vnfm)

VNF Lifecycle Management interface (as produced by the VNFM towards the NFVO).

VNF Performance Management interface (as produced by the VNFM towards the NFVO).

VNF Fault Management interface (as produced by the VNFM towards the NFVO).

VNF Indicator interface (as produced by the VNFM towards the NFVO).

VNF Lifecycle Operation Granting interface (as produced by the NFVO towards the VNFM).

VNF Package Management interface (as produced by the NFVO towards the VNFM).

Virtualised Resources Quota Available Notification interface (as produced by the NFVO towards the VNFM).

VNF Snapshot Package Management interface (as produced by the VNFM) - Release 3 only

This specification fulfils the requirements specified in ETSI GS NFV-IFA 007

Published specifications Issue Tracker
NFV-SOL 005

(Os-Ma-Nfvo)

NSD Management interface (as produced by the NFVO towards the OSS/BSS)

NS Lifecycle Management interface (as produced by the NFVO towards the OSS/BSS)

NS Performance Management interface (as produced by the NFVO towards the OSS/BSS)

NS Fault Management interface (as produced by the NFVO towards the OSS/BSS)

VNF Package Management interface (as produced by the NFVO towards the OSS/BSS)

NFVI Capacity Information interface (as produced by the NFVO) - Release 3 only

VNF Snapshot Package Management interface (as produced by the NFVO) - Release 3 only

LCM Coordination interface (as produced by the OSS/BSS) - Release 3 only

This specification fulfils the requirements specified in ETSI GS NFV-IFA 013

Published specifications Issue Tracker

Note that ETSI GS NFV-SOL 013 and ETSI GS NFV-SEC 022 complement the aforementioned specifications with common procedures (e.g. version management) and security aspects, respectively.

Draft specifications under development are available at https://docbox.etsi.org/ISG/NFV/Open/Drafts

Other ETSI NFV Management and Orchestration (NFV-MANO) APIs
APIs Published Versions Bug Tracker
NFV-SOL 009

(MANO management)

NFV-MANO configuration and information management interface

NFV-MANO performance management interface

NFV-MANO Fault Management interface

NFV-MANO log management interface

This specification fulfils the requirements specified in ETSI GS NFV-IFA 031

Published specifications Issue Tracker
NFV-SOL 011

(Or-Or)

VNF Lifecycle Management interface (as produced by the VNFM towards the NFVO).

VNF Performance Management interface (as produced by the VNFM towards the NFVO).

VNF Fault Management interface (as produced by the VNFM towards the NFVO).

VNF Indicator interface (as produced by the VNFM towards the NFVO).

VNF Lifecycle Operation Granting interface (as produced by the NFVO towards the VNFM).

VNF Package Management interface (as produced by the NFVO towards the VNFM).

Virtualised Resources Quota Available Notification interface (as produced by the NFVO towards the VNFM).

This specification fulfils the requirements specified in ETSI GS NFV-IFA 011

Published specifications Issue Tracker
NFV-SOL 012

(Policy Management)

Policy Management interface

Draft available Issue Tracker

Note that ETSI GS NFV-SOL 013 and ETSI GS NFV-SEC 022 complement the aforementioned specifications with common procedures (e.g. version management) and security aspects, respectively.

Draft specifications under development are available at https://docbox.etsi.org/ISG/NFV/Open/Drafts

OpenAPIs

For each of the APIs specified in the aforementionned documents, an OpenAPI representation is made available on the ETSI Forge Server. These representations, along with developement guidelines, can be found here.

Conformance testing

Conformance tests for APIs are specified in ETSI GS NFV-TST 010. The Robot code for all test cases is available on the ETSI Forge

Tutorials

Links to tutorials and webinars

Link

Return to NFV Solutions page

Return to ETSI ISG NFV page