From: Rajesh Velandy <Rajesh.Velandy@riftio.com>
Date: Thu, 7 Jul 2016 20:50:59 +0000 (-0400)
Subject: CLI for OSM
X-Git-Tag: v1.0.0~7^2
X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=refs%2Fchanges%2F22%2F222%2F1;p=osm%2FSO.git

CLI for OSM
---

diff --git a/designs/CLI_for_OSM.md b/designs/CLI_for_OSM.md
new file mode 100644
index 00000000..04808fb7
--- /dev/null
+++ b/designs/CLI_for_OSM.md
@@ -0,0 +1,39 @@
+# [CLI for OSM ](https://osm.etsi.org/gerrit/#/c/165/) #
+
+## Purpose ##
+This document describes the functional specification for the CLI for OSM feature. 
+
+## Impacted Modules ##
+SO
+
+## Data Model Changes ##
+No data model changes are expected as part of this feature.
+ 
+## Overview ##
+This feature will add a command line interface to OSM that allows configuration, viewing of operational data and execution of RPCs.
+
+## Feature description ##
+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.
+
+Specifically the following operations will be supported in the CLI.
+
+- Configuration of Various accounts
+- Updating NS/VNF descriptor in the catalog( The files specifed in the package updation will not be supported in R1)
+- Deleting an NS package from the catalog
+- Deleting a VNF package from the catalog
+- Launching NS instance with specific parameters (e.g. destination datacentre per VNF, VNF instance name)
+- Invoking a service primitive of an NS instance
+- Deleting NS instance
+
+In  addition to the above CLI features a script will  be provided that allows on boarding of an NS/VNF package to SO/Launchpad.
+
+The following limitations will exist for release1,
+
+- The SO CLI need to be run from the virtual machine where launchpad is running
+- 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.
+## Risks ##
+None
+
+## Assumptions ##
+See limitations in the description section.
+