API specifications: Difference between revisions

Revision as of 14:21, 10 December 2019

API conventions

ETSI GS NFV-SOL 015 (draft) 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) This specification fulfills 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). 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) 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.

Other ETSI NFV Management and Orchestration (NFV-MANO) APIs
	APIs	Published Versions	Bug Tracker
NFV-SOL 009 (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) This specification fulfils the requirements specified in ETSI GS NFV-IFA 009	Published specifications	Issue Tracker
NFV-SOL 011 (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). This specification fulfils the requirements specified in ETSI GS NFV-IFA 011	Published specifications	Issue Tracker
NFV-SOL 011 (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) This specification fulfills the requirements specified in ETSI GS NFV-IFA 012	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 versions under development are available

OpenAPIs

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

Tutorials

Links to tutorials and webinars

Link

Return to NFV Solutions page

Return to ETSI ISG NFV page

@@ Line 5: / Line 5: @@
   {| class="wikitable alternance center"
-  |+ ETSI NFV Management and Orchestration (NFV-MANO) APIs - Release 2
+  |+ ETSI NFV Management and Orchestration (NFV-MANO) Core APIs
   |-
   |
   ! scope="col" | APIs
   ! scope="col" | Published Versions
- ! scope="col" | Latest Drafts
   ! scope="col" | Bug Tracker
@@ Line 30: / Line 29: @@
   | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/ Published specifications]
- | [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ Draft]
   | [http://forge.etsi.org/mantis/set_project.php?project_id=153;217&make_default=no&ref=view_all_bug_page.php Issue Tracker]
   |-
@@ Line 50: / Line 48: @@
 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/ ETSI GS NFV-IFA 007]
+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.05.01_60/gs_nfv-sol003v020501p.pdf Published specifications]
- | [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ Draft]
   | [http://forge.etsi.org/mantis/set_project.php?project_id=153;218&make_default=no&ref=view_all_bug_page.php Issue Tracker]
   |-
@@ Line 69: / Line 66: @@
 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/ ETSI GS NFV-IFA 013]
+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]
- | [https://docbox.etsi.org/ISG/NFV/Open/Drafts/ Draft]
   | [http://forge.etsi.org/mantis/set_project.php?project_id=153;227&make_default=no&ref=view_all_bug_page.php Issue Tracker]
   |}
 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.
+ {| 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
+(Ve-Vnfm)   <br>
+ | align="left" |
+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)
+This specification fulfils the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/008/ ETSI GS NFV-IFA 009]
+ | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/ Published specifications]
+ | [http://forge.etsi.org/mantis/set_project.php?project_id=153;217&make_default=no&ref=view_all_bug_page.php Issue Tracker]
+ |-
+ ! scope="row" | NFV-SOL 011
+(Or-Vnfm)
+ | 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://forge.etsi.org/mantis/set_project.php?project_id=153;218&make_default=no&ref=view_all_bug_page.php Issue Tracker]
+ |-
+ ! scope="row" | NFV-SOL 011
+(Os-Ma-Nfvo)   <br>
+ | align="left" |
+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)
+This specification fulfills the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/013/ ETSI GS NFV-IFA 012]
+ | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/ 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]
+ |}
+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.
+Draft versions under development are available
 == OpenAPIs ==