Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • apps - lists all installed applications
  • app install <mvn-url> ... - installs applications by downloading from the specified URLs (not implemented yet)
  • app activate <app-name> ... - activates all specified applications
  • app deactivate <app-name> ... - deactivates all specified applications
  • app uninstall <app-name> ... - uninstalls all specified applications 

REST API and Shell Utility

Orchestration systems and tools can use the REST API to interact with the application subsystem either directly, or using the onos-app shell utility, which uses the REST API and has the following :

  • GET /onos/v1/applications - gets a list of all installed applications
  • GET /onos/v1/applications/<app-name> - gets the information about the named application
  • POST /onos/v1/applications - installs application using the posted app.xml or application package file (ZIP)
  • DELETE /onos/v1/applications/<app-name> - uninstalls the named application
  • POST /onos/v1/applications/<app-name>/active - activates the named application
  • DELETE /onos/v1/applications/<app-name>/active - deactivates the named application

Maven Example

 

Builtin Sample & Test Applications

...

usage:

  • onos-app install <app.xml or app.zip> ... - installs application by uploading the specified app.xml or application package file
  • onos-app install! <app.xml or app.zip> ... - installs and activates applications by uploading the specified app.xml or application package file
  • onos-app reinstall <app-name> <app.xml or app.zip> ... - re-installs application by uploading the specified app.xml or application package file
  • onos-app reinstall! <app-name> <app.xml or app.zip> ... - re-installs and activates applications by uploading the specified app.xml or application package file
  • onos-app activate <app-name> ... - activates the specified application
  • onos-app deactivate <app-name> ... - deactivates the specified application
  • onos-app uninstall <app-name> ... - uninstalls the specified application

Maven Example

Example will come soon.

Builtin Sample & Test Applications

The following list describes the inventory of all builtin sample and test applications:

  • org.onosproject.bgprouter -BGP router application, features
  • org.onosproject.config - Network configuration application
  • org.onosproject.demo - Flow throughput test application
  • org.onosproject.election - Master election test application
  • org.onosproject.fwd - Reactive forwarding application using flow subsystem
  • org.onosproject.intentperf - Intent performance test application
  • org.onosproject.metrics - Performance metrics collection
  • org.onosproject.mobility - Host mobility application
  • org.onosproject.null - Null southbound providers for testing
  • org.onosproject.openflow - OpenFlow protocol southbound providers
  • org.onosproject.optical - Packet/Optical use-case application
  • org.onosproject.proxyarp - Proxy ARP/NDP application
  • org.onosproject.sdnip - SDN/IP use-case application