Difference between revisions of "API specifications"

From NFVwiki
Jump to: navigation, search
(OpenAPIs)
(OpenAPIs)
Line 116: Line 116:
 
! EDITOR
 
! EDITOR
 
|-
 
|-
| VNF Configuration API
+
| style="text-align:left;" | VNF Configuration API
 
| SOL002
 
| SOL002
 
| VNF
 
| VNF
Line 125: Line 125:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Indicator API
+
| style="text-align:left;" | VNF Indicator API
 
| SOL002
 
| SOL002
 
| VNF/EM
 
| VNF/EM
Line 134: Line 134:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF IndicatorNotification API
+
| style="text-align:left;" | VNF IndicatorNotification API
 
| SOL002
 
| SOL002
 
| VNFM
 
| VNFM
Line 143: Line 143:
 
| [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]
 
| [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]
 
|-
 
|-
| Virtualised Resources Quota Available Notification API
+
| style="text-align:left;" | Virtualised Resources Quota Available Notification API
 
| SOL003
 
| SOL003
 
| NFVO
 
| NFVO
Line 152: Line 152:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Fault Management API
+
| style="text-align:left;" | VNF Fault Management API
 
| SOL003
 
| SOL003
 
| VNFM
 
| VNFM
Line 161: Line 161:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Fault Management Notification API
+
| style="text-align:left;" | VNF Fault Management Notification API
 
| SOL003
 
| SOL003
 
| NFVO
 
| NFVO
Line 170: Line 170:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Indicator API
+
| style="text-align:left;" | VNF Indicator API
 
| SOL003
 
| SOL003
 
| VNFM
 
| VNFM
Line 179: Line 179:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Indicator Notification API
+
| style="text-align:left;" | VNF Indicator Notification API
 
| SOL003
 
| SOL003
 
| NFVO
 
| NFVO
Line 188: Line 188:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Lifecycle Management API
+
| style="text-align:left;" | VNF Lifecycle Management API
 
| SOL003
 
| SOL003
 
| VNFM
 
| VNFM
Line 197: Line 197:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Lifecycle Operation Granting API
+
| style="text-align:left;" | VNF Lifecycle Operation Granting API
 
| SOL003
 
| SOL003
 
| NFVO
 
| NFVO
Line 206: Line 206:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Package Management API
+
| style="text-align:left;" | VNF Package Management API
 
| SOL003
 
| SOL003
 
| NFVO
 
| NFVO
Line 215: Line 215:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Package Management Notification API
+
| style="text-align:left;" | VNF Package Management Notification API
 
| SOL003
 
| SOL003
 
| VNFM
 
| VNFM
Line 224: Line 224:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Performance Management API
+
| style="text-align:left;" | VNF Performance Management API
 
| SOL003
 
| SOL003
 
| VNFM
 
| VNFM
Line 233: Line 233:
 
| [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]
 
| [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]
 
|-
 
|-
| VNF Performance Management Notification API
+
| style="text-align:left;" | VNF Performance Management Notification API
 
| SOL003
 
| SOL003
 
| NFVO
 
| NFVO

Revision as of 16:39, 1 February 2018

API conventions

API specifications

APIs exposed on MANO reference points
APIs Latest Published Version v2.3.1 Latest Drafts Bug Tracker Draft OpenAPI
Ve-Vnfm
(NFV-SOL 002)

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 specification Draft Issue Tracker Git repository
Or-Vnfm
(NFV-SOL 003)

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 fulfills the requirements specified in ETSI GS NFV-IFA 007

Published specification Draft Issue Tracker Git repository
Os-Ma-Nfvo
(NFV-SOL 005)

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 013

Not Applicable Draft Issue Tracker Work In Progress

Tutorials

Links to tutorials and webinars

OpenAPIs

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 here.

How to use the links:

=> Beginners are recommended to start navigating the links in the UI column.
  • 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 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 click here.

Interface Ref Point Producer PDF YAML JSON UI EDITOR
VNF Configuration API SOL002 VNF Link Link Link Link Link
VNF Indicator API SOL002 VNF/EM Link Link Link Link Link
VNF IndicatorNotification API SOL002 VNFM Link Link Link Link Link
Virtualised Resources Quota Available Notification API SOL003 NFVO Link Link Link Link Link
VNF Fault Management API SOL003 VNFM Link Link Link Link Link
VNF Fault Management Notification API SOL003 NFVO Link Link Link Link Link
VNF Indicator API SOL003 VNFM Link Link Link Link Link
VNF Indicator Notification API SOL003 NFVO Link Link Link Link Link
VNF Lifecycle Management API SOL003 VNFM Link Link Link Link Link
VNF Lifecycle Operation Granting API SOL003 NFVO Link Link Link Link Link
VNF Package Management API SOL003 NFVO Link Link Link Link Link
VNF Package Management Notification API SOL003 VNFM Link Link Link Link Link
VNF Performance Management API SOL003 VNFM Link Link Link Link Link
VNF Performance Management Notification API SOL003 NFVO Link Link Link Link Link

Link

Return to NFV Solutions page

Return to ETSI ISG NFV page