designs/CLI_for_OSM.md

   1 # [CLI for OSM ](https://osm.etsi.org/gerrit/#/c/165/) #
   2
   3 ## Purpose ##
   4 This document describes the functional specification for the CLI for OSM feature.
   5
   6 ## Impacted Modules ##
   7 SO
   8
   9 ## Data Model Changes ##
  10 No data model changes are expected as part of this feature.
  11
  12 ## Overview ##
  13 This feature will add a command line interface to OSM that allows configuration, viewing of operational data and execution of RPCs.
  14
  15 ## Feature description ##
  16 Release1 will provide a command line interface(CLI) to access the northbound interface for SO.  The CLI will be model driven and support every config node and  RPCs supported in the OSM data model.
  17
  18 Specifically the following operations will be supported in the CLI.
  19
  20 - Configuration of Various accounts
  21 - Updating NS/VNF descriptor in the catalog( The files specifed in the package updation will not be supported in R1)
  22 - Deleting an NS package from the catalog
  23 - Deleting a VNF package from the catalog
  24 - Launching NS instance with specific parameters (e.g. destination datacentre per VNF, VNF instance name)
  25 - Invoking a service primitive of an NS instance
  26 - Deleting NS instance
  27
  28 In  addition to the above CLI features a script will  be provided that allows on boarding of an NS/VNF package to SO/Launchpad.
  29
  30 The following limitations will exist for release1,
  31
  32 - The SO CLI need to be run from the virtual machine where launchpad is running
  33 - The SO CLI is not meant to be used as the interface to hit the northbound APIs of SO. Any systems (Jenkins automation tests, OSS/BSS) need to use rest APIs to interact with SO.
  34 ## Risks ##
  35 None
  36
  37 ## Assumptions ##
  38 See limitations in the description section.
  39