API specifications: Difference between revisions

From NFVwiki
No edit summary
Line 26: 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/ 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/ Published specifications]
  | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/ Published specifications]
Line 47: Line 51:


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).
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]
This specification fulfils the requirements specified in [http://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/007/ ETSI GS NFV-IFA 007]
Line 65: Line 71:


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)
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 [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]
Line 72: Line 84:
  |}
  |}
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.  
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


  {| class="wikitable alternance center"
  {| class="wikitable alternance center"
Line 83: Line 97:
  |-
  |-
  ! scope="row" | NFV-SOL 009
  ! scope="row" | NFV-SOL 009
(Ve-Vnfm)  <br>
(MANO management)  <br>
  | align="left" |  
  | align="left" |  
VNF Lifecycle Management interface (as produced by the VNFM towards the EM/VNF)
NFV-MANO configuration and information management interface


VNF Performance Management interface (as produced by the VNFM towards the EM)
NFV-MANO performance management interface


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


VNF Indicator interface (as produced by the EM/VNF towards the VNFM)
NFV-MANO log management interface


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/031/ ETSI GS NFV-IFA 031]
 
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://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]  
  | [http://tinyurl.com/t9dhvpq Issue Tracker]  
  |-
  |-
  ! scope="row" | NFV-SOL 011
  ! scope="row" | NFV-SOL 011
(Or-Vnfm)   
(Or-Or)   
  | align="left" |  
  | 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 120: Line 132:


  | [http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf Published specifications]
  | [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]  
  | [http://tinyurl.com/wgdrdb6 Issue Tracker]  
  |-
  |-
  ! scope="row" | NFV-SOL 011
  ! scope="row" | NFV-SOL 012
(Os-Ma-Nfvo)  <br>
(Policy Management)  <br>
  | align="left" |  
  | align="left" |  
NSD Management interface (as produced by the NFVO towards the OSS/BSS)
Policy Management interface
 
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)
  | [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]
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.  
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  
Draft specifications under development are available at https://docbox.etsi.org/ISG/NFV/Open/Drafts


== OpenAPIs ==
== OpenAPIs ==

Revision as of 13:51, 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)

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

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