API specifications: Difference between revisions

From NFVwiki
No edit summary
 
(71 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== API methodology ==
*[https://docbox.etsi.org/ISG/NFV/Open/Other API methodology document]
== 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.
[[File:NFVSOL(17)000050r4_ETSI_NFV_SOL_REST_API_Conventions.pdf]]


== 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" | Release v2.3.1/Draft
  ! scope="col" | Published Versions
! scope="col" | Swagger
  ! scope="col" | Bug Tracker
  ! scope="col" | Bug Tracker
  |-
  |-
  ! scope="row" | Ve-Vnfm
  ! 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 30: Line 26:
VNF Configuration interface (as produced by the VNF towards the VNFM)
VNF Configuration interface (as produced by the VNF towards the VNFM)


| [https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL002_Ve-Vnfm_protocols Draft]
VNF LCM Coordination interface (as produced by the VNF/EM) - Release 3 only
  | Work In Progress
 
  | Work In Progress
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/ 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" | Or-Vnfm
  ! 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 50: 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).


  | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.03.01_60/gs_NFV-SOL003v020301p.pdf Published specification]
VNF Snapshot Package Management interface (as produced by the VNFM) - Release 3 only
  | Work In Progress
 
| Work In Progress
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/ 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" | Os-Ma-Nfvo
  ! 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 66: 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)


| [https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL005_Os-Ma-nfvo_APIs Draft]
NFVI Capacity Information interface (as produced by the NFVO) - Release 3 only
  | Work In Progress
 
  | Work In Progress
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]
 
  |}
  |}
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 specifications under development are available at https://docbox.etsi.org/ISG/NFV/Open/Drafts


== Tutorials ==
{| 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]
 
|}
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 specifications under development are available at https://docbox.etsi.org/ISG/NFV/Open/Drafts


Links to tutorials and webinars
== 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_Representations|here]].


*[https://www.brighttalk.com/webcast/6985/263719/common-api-for-nfv-interop  Webinar on APIs for interoperability]
== Conformance testing ==
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]


== Testing ==
== Tutorials ==


Place holder for links to TST material
Links to tutorials and webinars


*[https://www.brighttalk.com/webcast/6985/263719/common-api-for-nfv-interop Webinar on APIs for interoperability]
*[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]


== Link ==
== Link ==


[https://nfvwiki.etsi.org/index.php?title=NFVSolutions Return to NFV Solutions page]
[https://nfvwiki.etsi.org/index.php?title=NFV_Solutions Return to NFV Solutions page]


[http://www.etsi.org/technologies-clusters/technologies/nfv Return to ETSI ISG NFV page]
[http://www.etsi.org/technologies-clusters/technologies/nfv Return to ETSI ISG NFV page]

Latest revision as of 08:47, 26 November 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

Retrieved from "https://nfvwiki.etsi.org/index.php?title=API_specifications&oldid=3692"