NFV API Reference

Use the StarlingX NFV API for NFVI orchestration.

Search NFV API content using the search page.

API reference

• NFV VIM API v1
  • Keystone Authentication Request
  • API versions
  • Software Deploy Strategy
  • Firmware Update Strategy
  • System Config Update Strategy
  • Current Strategy
  • Orchestrated Software Deployment Use Cases and Procedure
  • Software deploy Orchestration for Patch Release and Major Release Update
  • Check if there is any existing strategy
  • Check System Health
  • Check for alarms
  • Upload of software release on system controller
  • DC - Prestage software release on subcloud
  • DC - Apply prestage-strategy
  • Steps
  • 1) Create sw-deploy-strategy
  • 2) Show the strategy details
  • 3) Apply sw-deploy-strategy
  • 4) Apply strategy with stage-id(Optional)
  • 5) Check the progress of the apply phase using below API and wait for it to complete
  • 6) Post-requisite
  • Software deploy Orchestration for Patch Release Removal
  • Check if current strategy is existing
  • Shows software list
  • Steps
  • 1) Create sw-deploy-strategy
  • 2) Show the strategy details
  • 3) Apply sw-deploy-strategy
  • 4) Apply strategy with stage-id(Optional)
  • 5) Show sw-deploy-strategy
  • 6) Post-requisite
  • Software deployment Orchestration For Patch and Major Release Rollback
  • Check if existing strategy is in failed state
  • Check System Health
  • Check for alarms
  • Steps
  • 1) Delete existing sw-deploy-strategy
  • 2) Create new rollback sw-deploy-strategy
  • 3) Show sw-deploy strategy
  • 4) Apply sw-deploy-strategy
  • 5) Show sw-deploy-strategy
  • 6) Post-requisite