-ONAP Command-line interface (CLI)
+OPEN Command-line interface (CLI)
==================================
-**One Command to command whole Onap !!**
+Provides unified commands to operate any cloud enabled software
+products from Linux/Web console. Configure the following environment
+variables, before using it:
-Provides unified commands to operate ONAP from Linux console.
-Configure the following environment variables, before using it:
-
-1. **HOST_URL** - Onap Micro service bus(MSB) URL or a service URL
-2. **HOST_USERNAME** - Onap user name
-3. **HOST_PASSWORD** - Onap user password
+1. **HOST_URL** - Catalog service URL or a service URL
+2. **HOST_USERNAME** - Service user name
+3. **HOST_PASSWORD** - Service password
To Run a command
-----------------
And use the directive set to set the values for following parameters:
-1. **onap-host-url** - Onap Micro service bus(MSB) URL or a service URL
-2. **host-username** - Onap user name
-3. **host-password** - Onap user password
+1. **host-url** - Catalog service URL or a service URL
+2. **host-username** - Service user name
+3. **host-password** - Service password
Set the product version
------------------------
Debug Mode
----------
To run in debug mode, set following environment variables:
-1. ONAP_CLI_DEBUG - By default its false, otherwise Set to true
-2. ONAP_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
+1. CLI_DEBUG - By default its false, otherwise Set to true
+2. CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
More details
-------------
mv /tmp/gotty/bin/gotty /usr/sbin/
#Environments
-ENV ONAP_CLI_HOME /opt/onap/cli
+ENV OPEN_CLI_HOME /opt/onap/cli
ENV ONAP_CLI_DEBUG false
ENV ONAP_CLI_DEBUG_PORT 5005
ENV CLI_MODE console
ENV ONAP_PASSWORD guest
#Copy CLI into docker
-ADD ./STAGE $ONAP_CLI_HOME
-WORKDIR $ONAP_CLI_HOME
+ADD ./STAGE $OPEN_CLI_HOME
+WORKDIR $OPEN_CLI_HOME
#Setup the run time environment (RTE)
#RTE: CLI
if [ ! -d ./onap-cli-schema ]; then mkdir ./onap-cli-schema; fi
#Create the readable README
-RUN pandoc -t plain $ONAP_CLI_HOME/docs/README.md > $ONAP_CLI_HOME/docs/onap-readme.txt
+RUN pandoc -t plain $OPEN_CLI_HOME/docs/README.md > $OPEN_CLI_HOME/docs/onap-readme.txt
#RTE: lighttpd
COPY ./STAGE/http/lighttpd/lighttpd.conf /etc/lighttpd/lighttpd.conf
-server.document-root = "/var/www-data/servers/onap-cli/"
+server.document-root = "/var/www-data/servers/open-cli/"
server.username = "www-data"
server.groupname = "www-data"
server.port = 80
-<!DOCTYPE html><html><head><link rel="icon" href="./onap-cli.png">
-<meta charset="utf-8"><title>ONAP CLI</title><style></style>
-<script>
-function redirectToConsole(){
- window.location.href="http://"+ window.location.hostname + ":9090";
-}
-</script>
-</head>
-
-<body onload="showSlides()" style="background-color: white;color: black">
+<!DOCTYPE html><html><head><link rel="icon" href="./open-cli.png">
+<meta charset="utf-8"><title>ONAP CLI</title><style></style></head><body id="preview">
+<h1><a id="ONAP_Commandline_interface_CLI_0"></a>ONAP Command-line interface (CLI)</h1>
+<p style="color:blue"><strong>One Command to command whole Onap !!</strong></p>
+<p>Provides unified commands to operate ONAP from Linux console and Web console.</p>
+
+<h2><a id="Download_42"></a>To download</h2>
+<p style="color:red">Please download ONAP CLI <a href="./onap-cli.zip">here</a></p>
+
+<h3><a id="Download_42"></a>To install</h3>
+<p>Please follow the instructions given below for installing ONAP CLI.</p>
+<ol>
+<li>Un-zip the above download file into <b>/opt/onap/cli folder</b></li>
+<li>Run the following commands:
+<br>export ONAP_CLI_HOME=$CLI_INSTALL_DIR
+<br>export CLI_PRODUCT_VERSION=onap-1.1
+<br>
+<br>cd $CLI_INSTALL_DIR
+<br>
+<br>if [ ! -d ./data ]; then mkdir ./data; fi
+<br>if [ ! -d ./onap-cli-schema ]; then mkdir ./onap-cli-schema; fi
+<br>
+<br>chmod +x ./bin/onap.sh
+<br>
+<br>#Make onap available in path
+<br>ln ./bin/onap.sh $CLI_BIN
+<br>
+<br>#Print the version
+<br>onap -v</li>
+</ol>
+
+<h2><a id="Console_42"></a>Web Command console</h2>
+<p style="color:blue">To open Console, Click <img src="./onap-cli.png" alt="Web Command console" style="width:30px;height:22px;" onclick="redirectToConsole();"> </p>
+
+<h2><a id="To_Run_a_command_12"></a>To Run a command</h2>
+
+<p>Configure the following environment variables, before using it in Linux console:</p>
+<ol>
+<li><strong>HOST_URL</strong> - Onap Micro service bus(MSB) URL or a service URL</li>
+<li><strong>HOST_USERNAME</strong> - Onap user name</li>
+<li><strong>HOST_PASSWORD</strong> - Onap user password</li>
+</ol>
+
+<p>Type <strong>onap <command></strong> from Linux console.</p>
+
+<h2><a id="To_Run_in_Interactive_mode_16"></a>To Run in Interactive mode</h2>
+<p>Type <strong>onap</strong> from linux console</p>
+
+<h2><a id="More_details_42"></a>More details</h2>
+<p><a href="https://wiki.onap.org">https://wiki.onap.org</a></p>
+
+<h2><a id="Download_42"></a>To download</h2>
+<p style="color:red">Please download ONAP CLI <a href="./open-cli.zip">here</a></p>
</body></html>
<html>
<head>
<title>OCC</title>
- <link rel="icon" type="image/png" href="./onap-cli.png">
+ <link rel="icon" type="image/png" href="./open-cli.png">
<link rel="stylesheet" href="./css/index.css" />
<link rel="stylesheet" href="./css/xterm.css" />
<link rel="stylesheet" href="./css/xterm_customize.css" />
CLI_INSTALL_DIR=/opt/onap/cli
CLI_ZIP=cli.zip
CLI_BIN=/usr/bin/onap
-export ONAP_CLI_HOME=$CLI_INSTALL_DIR
-export CLI_PRODUCT_VERSION=onap-1.1
+export OPEN_CLI_HOME=$CLI_INSTALL_DIR
#create install dir
if [ -d $CLI_INSTALL_DIR ]
unzip $CLI_ZIP
if [ ! -d ./data ]; then mkdir ./data; fi
-if [ ! -d ./onap-cli-schema ]; then mkdir ./onap-cli-schema; fi
+if [ ! -d ./open-cli-schema ]; then mkdir ./open-cli-schema; fi
chmod +x ./bin/onap.sh
#Make onap available in path
<version>1.5</version>
<executions>
<execution>
- <id>onap-cli-deployment</id>
+ <id>open-cli-deployment</id>
<phase>package</phase>
<goals>
<goal>execute</goal>
ant.delete(dir: "${deployUnzip}/lib")
ant.mkdir(dir: "${deployUnzip}/lib")
- ant.delete(dir: "${deployUnzip}/onap-cli-schema")
- ant.mkdir(dir: "${deployUnzip}/onap-cli-schema")
+ ant.delete(dir: "${deployUnzip}/open-cli-schema")
+ ant.mkdir(dir: "${deployUnzip}/open-cli-schema")
ant.delete(dir: "${deployUnzip}/data")
ant.mkdir(dir: "${deployUnzip}/data")
ant.copy(todir:
"${deployUnzip}/conf") {
fileset(file:
- "${project.build.directory}/../../../framework/src/main/resources/onap.properties")
+ "${project.build.directory}/../../../framework/src/main/resources/open-cli.properties")
}
ant.copy(todir:
# limitations under the License.
#*******************************************************************************
-if [ -z "$ONAP_CLI_HOME" ]
+if [ -z "$OPEN_CLI_HOME" ]
then
- echo "There is no ONAP_CLI_HOME"
+ echo "There is no OPEN_CLI_HOME"
exit 1
fi
-CLASSPATH=$ONAP_CLI_HOME:$ONAP_CLI_HOME/conf:$ONAP_CLI_HOME/docs
-for entry in "$ONAP_CLI_HOME/lib"/*
+CLASSPATH=$OPEN_CLI_HOME:$OPEN_CLI_HOME/conf:$OPEN_CLI_HOME/docs
+for entry in "$OPEN_CLI_HOME/lib"/*
do
CLASSPATH=$CLASSPATH:$entry
done
// For auth type commands, login and logout logic is not required
boolean isAuthRequired = !this.onapService.isNoAuth()
&& "false".equals(paramMap.get(Constants.DEFAULT_PARAMETER_OUTPUT_NO_AUTH).getValue())
- && !this.getType().equals(CommandType.AUTH);
+ && this.getType().equals(CommandType.CMD);
if (!isCommandInternal()) {
this.authClient = new OnapAuthClient(
String errorNote = "";
String usageNote = "\n\nTo enable a product version, use one of following methods:"
+ "\n 1. set env variable CLI_PRODUCT_VERSION"
- + "\n 2. set cli.product.version in onap.properties"
+ + "\n 2. set cli.product.version in open-cli.properties"
+ "\n 3. in interactive mode, use the directive 'use <product version>'\n";
if (!this.availableProductVersions.contains(configuredProductVersion)) {
public static final String SSLCONTEST_TLS = "TLSV1.2";
public static final String APPLICATION_JSON = "application/json";
- public static final String X_AUTH_TOKEN = "x-auth-token";
- public static final String AUTH_SERVICE = "cli.auth_service";
- public static final String AUTH_SERVICE_VERSION = "v1";
- public static final String TOKEN = "{\"userName\": \"%s\",\"password\": \"%s\"}";
- public static final String MSB_URI = "/api/microservices/v1";
- public static final String MSB_SERVICE_URI = MSB_URI + "/services/%s/version/%s";
-
- public static final String API_GATEWAY = "cli.api_gateway";
public static final String SERVICE_NAME = "cli.service_name";
//http
public static final String DEFAULT_PARAMETER_OUTPUT_NO_AUTH = "no-auth";
// Configuration properties
- public static final String CONF = "onap.properties";
- public static final String ONAP_IGNORE_AUTH = "cli.ignore_auth";
- public static final String ONAP_CLI_VERSION = "cli.version";
- public static final String ONAP_CLI_PRODUCT_VERSION = "cli.product.version";
- public static final String ONAP_CLI_PRODUCT_VERSION_ENV_NAME = "CLI_PRODUCT_VERSION";
+ public static final String CONF = "open-cli.properties";
+ public static final String OPEN_IGNORE_AUTH = "cli.ignore_auth";
+ public static final String OPEN_CLI_VERSION = "cli.version";
+ public static final String OPEN_CLI_PRODUCT_VERSION = "cli.product.version";
+ public static final String OPEN_CLI_PRODUCT_VERSION_ENV_NAME = "CLI_PRODUCT_VERSION";
public static final String HTTP_API_KEY_USE_COOKIES = "cli.http.api_key_use_cookies";
public static final String EXCLUDE_PARAMS_INTERNAL_CMD = "cli.exclude_params_internal_cmd";
public static final String NO_AUTH_DISABLE_INCLUDE_PARAMS_EXTERNAL_CMD = "cli.no_auth_disable_include_params_external_cmd";
public static final String PORTRAINT_COLUMN_NAME_PROPERTY = "property";
public static final String PORTRAINT_COLUMN_NAME_VALUE = "value";
- public static final String EXTERNAL_SCHEMA_DIRECTORY = "onap-cli-schema";
+ public static final String EXTERNAL_SCHEMA_DIRECTORY = "open-cli-schema";
public static final String EXTERNAL_YAML_PATTERN = "/**/*.yaml";
public static final String EXTERNAL_JSON_PATTERN = "/**/*.json";
public static final String EXTERNAL_SCHEMA_PATH_PATERN = EXTERNAL_SCHEMA_DIRECTORY + EXTERNAL_YAML_PATTERN;
* @return boolean
*/
public static boolean isAuthIgnored() {
- if ("true".equals(prps.getProperty(Constants.ONAP_IGNORE_AUTH))) {
+ if ("true".equals(prps.getProperty(Constants.OPEN_IGNORE_AUTH))) {
return true;
}
}
public static String getVersion() {
- return prps.getProperty(Constants.ONAP_CLI_VERSION);
+ return prps.getProperty(Constants.OPEN_CLI_VERSION);
}
public static String getEnabledProductVersion() {
- String version = System.getenv(Constants.ONAP_CLI_PRODUCT_VERSION_ENV_NAME);
+ String version = System.getenv(Constants.OPEN_CLI_PRODUCT_VERSION_ENV_NAME);
if (version == null) {
- version = prps.getProperty(Constants.ONAP_CLI_PRODUCT_VERSION);
+ version = prps.getProperty(Constants.OPEN_CLI_PRODUCT_VERSION);
}
return version;
}
return false;
}
- public static String getXAuthTokenName() {
- return prps.getProperty(Constants.SERVICE_AUTH_BASIC_HTTP_HEADERS + "." + Constants.X_AUTH_TOKEN);
- }
-
public static String getInternalCmd() {
return prps.getProperty(Constants.SERVICE_NAME);
}
- public static String getApiGateway() {
- return prps.getProperty(Constants.API_GATEWAY);
- }
-
- public static String getAuthService() {
- return prps.getProperty(Constants.AUTH_SERVICE);
- }
-
public static String getAuthType() {
return prps.getProperty(Constants.SERVICE_AUTH, Constants.AUTH_BASIC);
}
type: auth
service:
- name: onap-cli
+ name: open-cli
version: 1.0.0
results:
type: auth
service:
- name: onap-cli
+ name: open-cli
version: 1.0.0
service:
auth: none
- name: onap-cli
+ name: open-cli
version: 1.0.0
mode: direct
open_cli_schema_version: 1.0
name: schema-refresh
-description: Onap command to refresh schemas stored in onap_cli_schema folders.
+description: Onap command to refresh schemas stored in OPEN_cli_schema folders.
version: cli-1.0
service:
auth: none
- name: onap-cli
+ name: open-cli
version: 1.0.0
results:
direction: landscape
version: cli-1.0
service:
auth: none
- name: onap-cli
+ name: open-cli
version: 1.0.0
default_parameters:
exclude:
cli.ignore_auth=false
-cli.version=1.0
cli.http.api_key_use_cookies=true
cli.discover_always=false
-cli.service_name=onap-cli
-cli.api_gateway=msb
-cli.auth_service=auth
+cli.service_name=open-cli
+cli.product.version=cli-1.0
+cli.version=1.0
# service section
cli.exclude_params_internal_cmd=host-username,host-password,host-url,no-auth
cli.no_auth_enable_exclude_params_external_cmd=host-username,host-password,no-auth
cli.no_auth_enable_include_params_external_cmd=host-url
-cli.http.basic.common_headers=x-auth-token,x-transaction-id,x-app-id
-cli.http.basic.common_headers.x-auth-token=Authorization
-cli.http.basic.common_headers.x-transaction-id=X-TransactionId
-cli.http.basic.common_headers.x-transaction-id.value=req-uuid
-cli.http.basic.common_headers.x-app-id=X-FromAppId
-cli.http.basic.common_headers.x-app-id.value=onap-cli
-
-# Service specific headers
-cli.http.basic.common_headers.sdc=user-id
-cli.http.basic.common_headers.sdc.user-id=USER_ID
-cli.http.basic.common_headers.sdc.user-id.value=${host-username}
-
-#TODO mrkanag add support for aaf like defined above for basic
-#cli.service.auth=aaf
-
#schema validation
cli.schema.top_level_params_list=open_cli_schema_version,name,version,description,service,parameters,results,http,type
cli.schema.top_level_mandatory_list=open_cli_schema_version
cli.schema.auth_values=none,basic
cli.schema.mode_values=direct,catalog
+<<<<<<< 5301969fc26714a8494882027116282898278f32:framework/src/main/resources/onap.properties
#product version
cli.product.version=cli-1.0
cli.sample.gen.enable=false
cli.sample.gen.target=.
+=======
+>>>>>>> Migrate onap-cli-schema into open-cli-schema:framework/src/main/resources/open-cli.properties
}
private void createDir() {
- URL url = OnapCommandRegistrarTest.class.getClassLoader().getResource("onap-cli-schema");
+ URL url = OnapCommandRegistrarTest.class.getClassLoader().getResource("open-cli-schema");
if (url != null) {
String path = url.getPath();
- path = path.replaceFirst("onap-cli-schema", "data");
+ path = path.replaceFirst("open-cli-schema", "data");
File file = new File(path);
if (!file.exists()) {
file.mkdir();
@Test
public void isAuthIgnoredTest() throws IOException {
Properties prps = new Properties();
- prps.load(OnapCommandConfg.class.getClassLoader().getResourceAsStream("onap.properties"));
+ prps.load(OnapCommandConfg.class.getClassLoader().getResourceAsStream("open-cli.properties"));
boolean auth = OnapCommandConfg.isAuthIgnored();
Assert.assertTrue(auth == Boolean.valueOf(prps.getProperty("cli.ignore_auth")));
Assert.assertTrue(OnapCommandConfg.isCookiesBasedAuth() == Boolean
protected void run() throws OnapCommandException {}
};
OnapCommandUtils.loadSchema(cmd,
- ValidateSchemaTest.class.getClassLoader().getResource("onap.properties").getFile(),
+ ValidateSchemaTest.class.getClassLoader().getResource("open-cli.properties").getFile(),
true, true);
}
default, it is read from environment variable
HOST_PASSWORD. Secured.
-m | --host-url Onap MSB url. It is of type URL. By default, it
- is read from environment variable ONAP_MSB_URL.
+ is read from environment variable OPEN_MSB_URL.
-h | --help Onap command help message. It is of type STRING.
By default, it is false.
-v | --version Onap command service version. It is of type
open_cli_schema_version: 1.0
name: sample-create-http
description: Register microservice into Onap
-version: onap-1.0
+version: cli-1.0
service:
name: msb
version: v1
open_cli_schema_version: 1.0
name: sample-test
description: Onap sample command to test the command features
-version: onap-1.0
+version: cli-1.0
service:
name: sample
version: v1
-Onap Command-line interface (CLI).
+OPEN Command-line interface (CLI)
+==================================
- ____ __ ___
- ___ _ __ __ _ _ __ / ___| | |_ _|
- / _ \| '_ \ / _` | '_ \ | | | | | |
-| (_) | | | | (_| | |_) | | |___| |___ | |
- \___/|_| |_|\__,_| .__/ \____|_____|___|
- |_|
+ _____ _____ _ _____
+| _ | / __ \| | |_ _|
+| | | |_ __ ___ _ __ | / \/| | | |
+| | | | '_ \ / _ \ '_ \ | | | | | |
+\ \_/ / |_) | __/ | | | | \__/\| |_____| |_
+ \___/| .__/ \___|_| |_| \____/\_____/\___/
+ | |
+ |_|
+
+Provides unified commands to operate any cloud enabled software
+products from Linux/Web console. Configure the following environment
+variables, before using it:
-
-One Command to command whole Onap !! It provides the unified commands
-to access and operate Onap functionalities. To use this CLI, please
-configure the following environment variables:
-
-1. ONAP_MSB_URL - Onap Micro service bus(MSB) URL
-2. HOST_USERNAME - Onap user name
-3. HOST_PASSWORD - Onap user password
+1. HOST_URL - Catalog service URL or a service URL
+2. HOST_USERNAME - Service user name
+3. HOST_PASSWORD - Service password
To know the CLI version, type onap [-v|--version]
To know the CLI usage, type onap [-h|--help]
To know the usage of sub commands, type onap <command> [-h|--help]
-To know more, please refer the Onap wiki https://wiki.onap.org
+To know more, please refer the wiki https://wiki.onap.org
@Test
public void testVersionShort() {
- this.handle(new String[] { "--v" });
+ this.handle(new String[] { "-v" });
}
@Test
}
@Test
- public void testHandleSampleCommandFailure() throws OnapCommandException {
+ public void testHandleSampleCommandFailure() throws OnapCommandException{
this.handle(new String[] { "sample-test", "--string-param"});
}
--- /dev/null
+open_cli_schema_version: 1.0
+name: vf-module-create
+description: Create a VF Module
+version: onap-1.1
+service:
+ name: mso
+ version: v2
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: lcp-cloudregion-id
+ description: AIC LCP node location identifier
+ type: string
+ short_option: l
+ long_option: lcp-cloudregion-id
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id (uuid)
+ type: string
+ short_option: w
+ long_option: tenant-id
+ is_optional: false
+ - name: vnf-instance-id
+ description: vnf instance id
+ type: string
+ short_option: y
+ long_option: vnf-instace-id
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: x
+ long_option: service-instace-id
+ is_optional: false
+ - name: parenet-service-model
+ description: parent service model name
+ type: string
+ short_option: z
+ long_option: parenet-service-model
+ is_optional: false
+ - name: supress-rollback
+ description: rollback changes if instantiation fails.
+ type: bool
+ short_option: r
+ long_option: supress-rollback
+ is_optional: true
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: i
+ long_option: instance-name
+ is_optional: false
+
+results:
+ direction: portrait
+ attribute:
+ - name: vf-instance-id
+ description: id for the created vf
+ type: string
+ scope: short
+
+http:
+ request:
+ uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules
+ method: PUT
+ body: '{"requestDetails":{"modelInfo":{"modelType":"vfModule","modelInvariantId":"ff5256d2-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e5-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12..base..module-0","modelVersion":"1"},"cloudConfiguration":{"lcpCloudRegionId":"${lcp-cloudregion-id}","tenantId":"${tenant-id}"},"requestInfo":{"instanceName":"${instance-name}","source":"VID","suppressRollback":"${supress-rollback}"},"relatedInstanceList":[{"relatedInstance":{"instanceId":"${service-instance-id}","modelInfo":{"modelType":"service","modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe","modelName":"${parenet-service-model}","modelVersion":"1.0"}}},{"relatedInstance":{"instanceId":"${vnf-instance-id}","modelInfo":{"modelType":"vnf","modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12","modelVersion":"1.0","modelCustomizationName":"vSAMP12 1"}}}],"requestParameters":{"userParams":[]}}}'
+
+ success_codes:
+ - 202
+ result_mpa:
+ vf-instance-id: $b{$.vfInstanceId}
+ sample_response:
+ body: '{"vfInstanceId":"234567AB"}'
--- /dev/null
+open_cli_schema_version: 1.0
+name: vnf-create
+description: Create a VNF
+version: onap-1.1
+service:
+ name: mso
+ version: v2
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: lcp-cloudregion-id
+ description: AIC LCP node location identifier
+ type: string
+ short_option: l
+ long_option: lcp-cloudregion-id
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id (uuid)
+ type: string
+ short_option: z
+ long_option: tenant-id
+ is_optional: false
+ - name: product-family-id
+ description: UUID for product family (named service id in AAI)
+ type: string
+ short_option: w
+ long_option: product-family-id
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: i
+ long_option: instance-name
+ is_optional: false
+ - name: supress-rollback
+ description: rollback changes if instantiation fails.
+ type: bool
+ short_option: r
+ long_option: supress-rollback
+ is_optional: true
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instance-id
+ is_optional: false
+ - name: parenet-service-model
+ description: parent service model name
+ type: string
+ short_option: x
+ long_option: parenet-service-model
+ is_optional: false
+
+results:
+ direction: portrait
+ attribute:
+ - name: vnf-instance-id
+ description: id for the created vnf
+ type: string
+ scope: short
+
+http:
+ request:
+ uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs
+ method: PUT
+ body: '{"requestDetails":{"modelInfo":{"modelType":"vnf","modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12","modelVersion":"1.0","modelCustomizationName":"vSAMP12 1"},"cloudConfiguration":{"lcpCloudRegionId": "${lcp-cloudregion-id}","tenantId":"${tenant-id}"},"requestInfo":{"instanceName":"${instance-name}","productFamilyId":"${product-family-id}","source":"VID","suppressRollback":"${supress-rollback}"},"relatedInstanceList":[{"relatedInstance":{"instanceId":"${service-instance-id}","modelInfo":{"modelType":"service","modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe","modelName":"${parenet-service-model}","modelVersion":"1.0"}}}],"requestParameters":{}}}'
+
+ success_codes:
+ - 202
+ result_mpa:
+ vnf-instance-id: $b{$.vnfInstanceId}
+ sample_response:
+ body: '{"vnfInstanceId":"234567AB"}'
--- /dev/null
+open_cli_schema_version: 1.0
+name: vnf-delete
+description: delete a VNF
+version: onap-1.1
+service:
+ name: mso
+ version: v2
+ auth: basic
+ mode: direct
+
+parameters:
+ - name: vnf-instance-id
+ description: id for vnf
+ type: string
+ short_option: x
+ long_option: vnf-instace-id
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instace-id
+ is_optional: false
+ - name: lcp-cloudregion-id
+ description: AIC LCP node location identifier
+ type: string
+ short_option: l
+ long_option: lcp-cloudregion-id
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id (uuid)
+ type: string
+ short_option: z
+ long_option: tenant-id
+ is_optional: false
+
+http:
+ request:
+ uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs
+ method: DELETE
+ body: '{"requestDetails":{"modelInfo":{"modelType":"vnf","modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff","modelName":"vSAMP12","modelVersion":"1"},"cloudConfiguration":{"lcpCloudRegionId":"mdt1","tenantId":"88a6ca3ee0394ade9403f075db23167e"},"requestInfo":{"source":"VID"},"requestParameters":{"userParams":[]}}}'
+
+ success_codes:
+ - 202
\ No newline at end of file
Code Review / cli.git / commitdiff