summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md34
-rw-r--r--deployment/docker/src/main/docker/Dockerfile23
-rw-r--r--deployment/docker/src/main/docker/docker-compose.yaml5
-rw-r--r--deployment/http/lighttpd/lighttpd.conf2
-rw-r--r--deployment/http/web/index.html109
-rw-r--r--deployment/http/web/onap-cli.pngbin29672 -> 0 bytes
-rw-r--r--deployment/http/web/open-cli.pngbin0 -> 12119 bytes
-rwxr-xr-xdeployment/zip/src/main/release/bin/oclip.sh2
-rw-r--r--docs/cmd_help.rst415
-rw-r--r--docs/open_cli_schema_version_1_0.rst6
-rw-r--r--docs/user_guide.rst4
-rw-r--r--framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java2
-rw-r--r--framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java4
-rw-r--r--framework/src/main/resources/default_input_parameters_http.yaml6
-rw-r--r--framework/src/test/resources/sample-cmd-test-help.txt2
-rw-r--r--main/src/main/resources/onap-readme.txt22
16 files changed, 422 insertions, 214 deletions
diff --git a/README.md b/README.md
index a69963b2..a400bb0c 100644
--- a/README.md
+++ b/README.md
@@ -5,21 +5,21 @@ Provides unified commands to operate any cloud enabled software
products from Linux/Web console. Configure the following environment
variables, before using it:
-1. **HOST_URL** - Catalog service URL or a service URL
-2. **HOST_USERNAME** - Service user name
-3. **HOST_PASSWORD** - Service password
+1. **OPEN_CLI_HOST_URL** - Catalog service URL or a service URL
+2. **OPEN_CLI_HOST_USERNAME** - Service user name
+3. **OPEN_CLI_HOST_PASSWORD** - Service password
To Run a command
-----------------
-Type **onap <command>** from linux console.
+Type **oclip <command>** from linux console.
To Run in Interactive mode
--------------------------
-Type **onap** from linux console.
+Type **oclip** from linux console.
And use the directive set to set the values for following parameters:
-1. **host-url** - Catalog service URL or a service URL
+1. **host-url** - Catalog service URL or a service URL
2. **host-username** - Service user name
3. **host-password** - Service password
@@ -27,12 +27,12 @@ Set the product version
------------------------
CLI framework is enhanced to handle multiple product versions at same
time. so to choose the product version, set evironment variable
-**CLI_PROUDCT_VERSION**.
+**OPEN_CLI_PROUDCT_IN_USE**.
NOTE: In interactive mode, product version can be selected using
typing **use <product-version>**
-Run *onap [-v|--version]* to see the CLI and available product version details
+Run *oclip [-v|--version]* to see the CLI and available product version details
Set the parameter values
------------------------
@@ -40,15 +40,19 @@ Use the directive 'set' for setting the values for parameters and 'unset' for un
Help
----
-*onap [-h|--help]*
-*onap <command> [-h|--help]*
+*oclip [-h|--help]*
+*oclip <command> [-h|--help]*
Debug Mode
----------
To run in debug mode, set following environment variables:
-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
--------------
-https://wiki.onap.org
+1. OPEN_CLI_DEBUG - By default its false, otherwise Set to true
+2. OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
+
+<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 Open CLI Platform <a href="./open-cli.zip">here</a></p>
+
diff --git a/deployment/docker/src/main/docker/Dockerfile b/deployment/docker/src/main/docker/Dockerfile
index 777e3ac8..e23a3c1b 100644
--- a/deployment/docker/src/main/docker/Dockerfile
+++ b/deployment/docker/src/main/docker/Dockerfile
@@ -10,15 +10,18 @@ RUN cd /tmp && curl -O https://storage.googleapis.com/golang/go1.9.linux-amd64.t
mv /tmp/gotty/bin/gotty /usr/sbin/
#Environments
-ENV OPEN_CLI_HOME /opt/onap/cli
+ENV OPEN_CLI_HOME /opt/oclip
ENV OPEN_CLI_DEBUG false
ENV OPEN_CLI_DEBUG_PORT 5005
ENV OPEN_CLI_MODE console
ENV OPEN_CLI_PRODUCT_IN_USE open-cli
-ENV HOST_URL http://localhost:8080
-ENV OPEN_USERNAME guest
-ENV OPEN_PASSWORD guest
+ENV OPEN_CLI_HOST_URL http://localhost:8080
+ENV OPEN_CLI_USERNAME guest
+ENV OPEN_CLI_PASSWORD guest
+
+ENV GOTTY_TITLE_FORMAT {{ .command }}
+ENV GOTTY_INDEX $OPEN_CLI_HOME/http/web/occ.html
#Copy CLI into docker
ADD ./STAGE $OPEN_CLI_HOME
@@ -27,18 +30,18 @@ WORKDIR $OPEN_CLI_HOME
#Setup the run time environment (RTE)
#RTE: CLI
RUN chmod +x ./bin/oclip.sh && \
- ln ./bin/oclip.sh /usr/sbin/onap && \
+ ln ./bin/oclip.sh /usr/sbin/oclip && \
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
#Create the readable README
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
-COPY ./STAGE/http/web /var/www-data/servers/onap-cli/
+COPY ./STAGE/http/web /var/www-data/servers/open-cli/
COPY ./STAGE/http/lighttpd/10-proxy.conf /etc/lighttpd/conf-enabled/
-COPY ./STAGE/installer/cli-*.zip /var/www-data/servers/onap-cli/onap-cli.zip
+COPY ./STAGE/installer/cli-*.zip /var/www-data/servers/open-cli/open-cli.zip
RUN if [ ! -f /var/log/lighttpd/access.log ]; then touch /var/log/lighttpd/access.log; fi
RUN cp /etc/lighttpd/conf-available/10-accesslog.conf /etc/lighttpd/conf-enabled/
@@ -49,9 +52,9 @@ EXPOSE 80
EXPOSE 8080
#Start
-ENTRYPOINT if [ "$OPEN_CLI_MODE" = "daemon" ]; then service lighttpd start; gotty --permit-write --reconnect onap; else onap -v && /bin/bash; fi
+ENTRYPOINT if [ "$OPEN_CLI_MODE" = "daemon" ]; then service lighttpd start; gotty --permit-write --reconnect oclip; else oclip -v && /bin/bash; fi
#Cleanup
RUN apt-get purge -y pandoc && apt-get autoremove -y && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/go /tmp/gotty /tmp/* /var/tmp/*
-RUN echo ONAP CLI docker successfully created !!
+RUN echo Open CLI docker successfully created !!
diff --git a/deployment/docker/src/main/docker/docker-compose.yaml b/deployment/docker/src/main/docker/docker-compose.yaml
index 370ca678..dfd3bb20 100644
--- a/deployment/docker/src/main/docker/docker-compose.yaml
+++ b/deployment/docker/src/main/docker/docker-compose.yaml
@@ -5,9 +5,6 @@ services:
image: onap/cli
environment:
OPEN_CLI_MODE: 'daemon'
- expose:
- - 80
- - 8080
ports:
- 8080:80
- 9090:8080
@@ -26,7 +23,5 @@ services:
environment:
OPEN_CLI_MODE: 'console'
OPEN_CLI_DEBUG: "true"
- expose:
- - 5005
ports:
- 5005:5005
diff --git a/deployment/http/lighttpd/lighttpd.conf b/deployment/http/lighttpd/lighttpd.conf
index 03765bf8..07a49644 100644
--- a/deployment/http/lighttpd/lighttpd.conf
+++ b/deployment/http/lighttpd/lighttpd.conf
@@ -24,7 +24,7 @@ server.modules = (
)
#server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
-#server.errorlog = "/var/log/lighttpd/error.log"
+server.errorlog = "/var/log/lighttpd/error.log"
server.pid-file = "/var/run/lighttpd.pid"
#compress.cache-dir = "/var/cache/lighttpd/compress/"
#compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
diff --git a/deployment/http/web/index.html b/deployment/http/web/index.html
index f8680f08..263d2bd7 100644
--- a/deployment/http/web/index.html
+++ b/deployment/http/web/index.html
@@ -1,70 +1,61 @@
<!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="OPEN_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>
+<meta charset="utf-8"><title>Open CLI Platform (OCLIP)</title><style></style></head><body id="preview">
+<script>
+function redirectToConsole(){
+ window.location.href="http://"+ window.location.hostname + ":9090";
+}
+</script>
+
+<h1 id="open-command-line-interface-cli">OPEN Command-line interface (CLI)</h1>
+<p>Provides unified commands to operate any cloud enabled software products from Linux/Web console. Configure the following environment variables, before using it:</p>
+<ol style="list-style-type: decimal">
+<li><strong>OPEN_CLI_HOST_URL</strong> - Catalog service URL or a service URL</li>
+<li><strong>OPEN_CLI_HOST_USERNAME</strong> - Service user name</li>
+<li><strong>OPEN_CLI_HOST_PASSWORD</strong> - Service password</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>
+<h2 id="to-run-a-command">To Run a command</h2>
+<p>Type <strong>oclip <command></strong> from linux console.</p>
+<h2 id="to-run-in-interactive-mode">To Run in Interactive mode</h2>
+<p>Type <strong>oclip</strong> from linux console.</p>
+<p>And use the directive set to set the values for following parameters:</p>
+<ol style="list-style-type: decimal">
+<li><strong>host-url</strong> - Catalog service URL or a service URL</li>
+<li><strong>host-username</strong> - Service user name</li>
+<li><strong>host-password</strong> - Service password</li>
</ol>
-
-<p>Type <strong>onap &lt;command&gt;</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="Set_the_product_version_20"></a>Set the product version</h2>
-<p>CLI framework is enhanced to handle multiple product versions at same<br>
-time. so to choose the product version, set evironment variable<br>
-<strong>CLI_PROUDCT_VERSION</strong>.</p>
-<p>NOTE: In interactive mode, product version can be selected using<br>
-typing <strong>use &lt;product-version&gt;</strong></p>
-<p>Run <em>onap [-v|–version]</em> to see the CLI and available product version details</p>
-<h2><a id="Help_31"></a>Help</h2>
-<p><em>onap [-h|–help]</em><br>
-<em>onap &lt;command&gt; [-h|–help]</em></p>
-<h2><a id="Debug_Mode_36"></a>Debug Mode</h2>
+<h2 id="set-the-product-version">Set the product version</h2>
+<p>CLI framework is enhanced to handle multiple product versions at same time. so to choose the product version, set evironment variable <strong>OPEN_CLI_PROUDCT_IN_USE</strong>.</p>
+<p>NOTE: In interactive mode, product version can be selected using typing <strong>use <product-version></strong></p>
+<p>Run <em>oclip [-v|--version]</em> to see the CLI and available product version details</p>
+<h2 id="set-the-parameter-values">Set the parameter values</h2>
+<p>Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.</p>
+<h2 id="help">Help</h2>
+<p><em>oclip [-h|--help]</em> <em>oclip <command> [-h|--help]</em></p>
+<h2 id="debug-mode">Debug Mode</h2>
<p>To run in debug mode, set following environment variables:</p>
-<ol>
+<ol style="list-style-type: decimal">
<li>OPEN_CLI_DEBUG - By default its false, otherwise Set to true</li>
<li>OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number</li>
</ol>
-<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="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 Open CLI Platform <a href="./open-cli.zip">here</a></p>
+
+<a id="Console_42"></a>Web Command console
+</h2>
+<p style="color:blue">Click me <a onclick="redirectToConsole();">here</a></p>
+
+<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
<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>
+=======
+>>>>>>> Normalize all env with OPEN_CLI
</body></html>
diff --git a/deployment/http/web/onap-cli.png b/deployment/http/web/onap-cli.png
deleted file mode 100644
index 60c3e151..00000000
--- a/deployment/http/web/onap-cli.png
+++ /dev/null
Binary files differ
diff --git a/deployment/http/web/open-cli.png b/deployment/http/web/open-cli.png
new file mode 100644
index 00000000..35f2b1ec
--- /dev/null
+++ b/deployment/http/web/open-cli.png
Binary files differ
diff --git a/deployment/zip/src/main/release/bin/oclip.sh b/deployment/zip/src/main/release/bin/oclip.sh
index e4a58502..a3d51940 100755
--- a/deployment/zip/src/main/release/bin/oclip.sh
+++ b/deployment/zip/src/main/release/bin/oclip.sh
@@ -18,7 +18,7 @@
if [ -z "$OPEN_CLI_HOME" ]
then
- echo "There is no OPEN_CLI_HOME"
+ echo "OPEN_CLI_HOME is not set."
exit 1
fi
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst
index 3b6f5a7e..e8e4fcad 100644
--- a/docs/cmd_help.rst
+++ b/docs/cmd_help.rst
@@ -375,10 +375,10 @@ Results::
-x | --vsp-id Onap VSP ID. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -430,10 +430,10 @@ where::
-y | --vlm-version VLM version. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -493,10 +493,10 @@ where::
optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -577,10 +577,10 @@ where::
0f4899c3-771c-462e-9dc8-ffa2de5532f6.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -647,10 +647,10 @@ where::
adbbea15-de1a-442a-a0e3-793779ea25bb.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -702,10 +702,10 @@ where::
-y | --vlm-version License Model version. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -836,10 +836,10 @@ Results::
93230cdb-aae3-4b87-a38a-fc4529e8aac9.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -892,10 +892,10 @@ where::
STRING. It is optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -948,7 +948,12 @@ Options::
where::
+<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
-x | --name Entitlement Pool name. It is of type STRING.
+=======
+<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
+ -x | --name Feature group name. It is of type STRING.
+>>>>>>> Normalize all env with OPEN_CLI
-y | --vlm-id License Model ID. It is of type STRING.
-e | --vlm-version License Model version. It is of type STRING.
-z | --description Description for Entitlement Pool. It is of type
@@ -980,6 +985,32 @@ where::
BOOL. By default, it is false.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+=======
+ -u | --onap-username Onap user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_USERNAME.
+ -p | --onap-password Onap user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_PASSWORD. Secured.
+ -m | --host-url Onap host url. It is of type URL. By default, it
+ is read from environment variable OPEN_HOST_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
+ STRING. By default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+>>>>>>> Normalize all env with OPEN_CLI
Results::
@@ -1016,10 +1047,10 @@ where::
-y | --vsp-version VSP version. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1168,10 +1199,10 @@ Results::
It is optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1247,10 +1278,10 @@ where::
It is optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1302,10 +1333,10 @@ where::
-y | --vsp-version Onap VSP version. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1441,10 +1472,10 @@ where::
3def24ae-701e-4c98-91a6-859c0f206759.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1527,10 +1558,10 @@ Results::
7b301a17-5eb2-413b-b214-fd1659fdf049.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1584,10 +1615,10 @@ where::
-z | --vsp-file CSAR File path. It is of type BINARY.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1644,10 +1675,10 @@ where::
-e | --service-type Onap service type. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1696,10 +1727,10 @@ where::
>>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1749,10 +1780,10 @@ where::
-y | --vsp-version VSP version. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1802,10 +1833,10 @@ where::
-y | --vsp-version VSP version. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1899,10 +1930,10 @@ where::
=======
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -1958,10 +1989,10 @@ where::
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2029,10 +2060,10 @@ where::
It is optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2101,10 +2132,10 @@ where::
>>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2182,10 +2213,10 @@ where::
-y | --vsp-version VSP version. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2235,10 +2266,10 @@ where::
-y | --vsp-version Onap VSP version. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2344,10 +2375,10 @@ where::
It is optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
>>>>>>> Migrate docs to use OPEN_ instead of ONAP_
@@ -2400,10 +2431,10 @@ where::
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2464,10 +2495,10 @@ where::
optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2552,10 +2583,10 @@ where::
-x | --customer-name Onap customer name. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2651,10 +2682,10 @@ where::
-r | --tenant-name Onap cloud tenant name. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2724,10 +2755,10 @@ where::
STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2790,10 +2821,10 @@ where::
>>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -2845,6 +2876,7 @@ Options::
where::
+<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
-b | --service-model-id Service model ID. It is of type STRING. It is
optional.
@@ -2873,6 +2905,8 @@ where::
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
=======
+=======
+>>>>>>> Normalize all env with OPEN_CLI
-x | --vnf-instace-id id for vnf. It is of type STRING.
-y | --service-instace-id unique id for service instance. It is of type
STRING.
@@ -2881,10 +2915,17 @@ where::
-z | --tenant-id openstack tenant id (uuid). It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
+<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
OPEN_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
OPEN_PASSWORD. Secured.
+=======
+ OPEN_CLI_USERNAME.
+ -p | --onap-password Onap user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_PASSWORD. Secured.
+>>>>>>> Normalize all env with OPEN_CLI
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -3084,10 +3125,10 @@ Results::
false.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -3303,10 +3344,10 @@ where::
-z | --tenant-id openstack tenant id (uuid). It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -3398,10 +3439,10 @@ where::
-i | --instance-name service instance name. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -3485,10 +3526,10 @@ where::
STRING. It is optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -3656,10 +3697,10 @@ where::
-null | --feature-group-id Feature Group ID. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -3765,10 +3806,10 @@ where::
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7348,6 +7389,7 @@ Options::
where::
+<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
-x | --ep-name Entitlement Pool name. It is of type STRING.
-y | --license-model-id License Model ID. It is of type STRING.
-z | --ep-description Description for Entitlement Pool. It is of type
@@ -7382,10 +7424,127 @@ where::
BOOL. By default, it is false.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+=======
+ -x | --group-name group name. It is of type STRING.
+ -y | --license-model-id License Model ID. It is of type STRING.
+ -z | --license-group-description Description for License Group. It is of type
+ STRING. It is optional.
+ -u | --onap-username Onap user name. It is of type STRING. By default,
+ it is read from environment variable
+ ONAP_USERNAME.
+ -p | --onap-password Onap user password. It is of type STRING. By
+ default, it is read from environment variable
+ ONAP_PASSWORD. Secured.
+ -m | --host-url Onap host url. It is of type URL. By default, it
+ is read from environment variable ONAP_HOST_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
+ STRING. By default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
+ ID License Group ID and is of type STRING.
+
+
+Error::
+
+ On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+[10] license-group-show
+-----------------------------------------------
+
+
+usage: onap license-group-show
+
+Details of the License Group
+
+Onap service: sdc v1.0
+
+Options::
+
+ [-x | --license-model-id] [-y | --license-group-id] [-u | --onap-username]
+ [-p | --onap-password] [-m | --host-url] [-h | --help]
+ [-v | --version] [-d | --debug] [-f | --format]
+ [-s | --long] [-t | --no-title] [-a | --no-auth]
+
+where::
+
+<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
+ -x | --license-model-id Onap License Model ID. It is of type STRING.
+ -y | --license-group-id Onap License Group ID. It is of type STRING.
+ -u | --onap-username Onap user name. It is of type STRING. By default,
+ it is read from environment variable
+ ONAP_USERNAME.
+ -p | --onap-password Onap user password. It is of type STRING. By
+ default, it is read from environment variable
+ ONAP_PASSWORD. Secured.
+ -m | --host-url Onap host url. It is of type URL. By default, it
+ is read from environment variable ONAP_HOST_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
+ STRING. By default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+=======
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -u | --onap-username Onap user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_USERNAME.
+ -p | --onap-password Onap user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_PASSWORD. Secured.
+ -m | --host-url Onap host url. It is of type URL. By default, it
+ is read from environment variable OPEN_HOST_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
+ STRING. By default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+>>>>>>> Normalize all env with OPEN_CLI
+>>>>>>> Normalize all env with OPEN_CLI
+
+
+Results::
+
+<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
ID Entitlement Pool ID and is of type STRING.
=======
@@ -7400,6 +7559,51 @@ Results::
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
OPEN_PASSWORD. Secured.
+=======
+<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
+ name License Group Name and is of type STRING.
+ ID License Group ID and is of type STRING.
+ description Description for the License Group and is of type
+ STRING.
+=======
+ name VSP Name and is of type STRING.
+ ID VSP ID and is of type STRING.
+ description Description for the VSP and is of type STRING.
+
+
+Error::
+
+ On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+vsp-submit
+-----------------------------------------------
+
+
+usage: onap vsp-submit
+
+Submit Vendor Software Product
+
+Onap service: sdc v1.0
+
+Options::
+
+ [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
+ [-m | --host-url] [-h | --help] [-v | --version]
+ [-d | --debug] [-f | --format] [-s | --long]
+ [-t | --no-title] [-a | --no-auth]
+
+where::
+
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -u | --onap-username Onap user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_USERNAME.
+ -p | --onap-password Onap user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_PASSWORD. Secured.
+>>>>>>> Normalize all env with OPEN_CLI
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7418,8 +7622,12 @@ Results::
BOOL. By default, it is false.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
>>>>>>> Migrate docs to use OPEN_ instead of ONAP_
>>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+=======
+>>>>>>> Normalize all env with OPEN_CLI
+>>>>>>> Normalize all env with OPEN_CLI
Error::
@@ -7450,10 +7658,17 @@ where::
-x | --customer-name Onap customer name. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
+<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
ONAP_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
ONAP_PASSWORD. Secured.
+=======
+ OPEN_CLI_USERNAME.
+ -p | --onap-password Onap user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_PASSWORD. Secured.
+>>>>>>> Normalize all env with OPEN_CLI
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable ONAP_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7519,10 +7734,10 @@ where::
optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7631,10 +7846,10 @@ where::
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7693,10 +7908,10 @@ where::
6dc30068-de3c-483a-a9a8-7d483a39425d.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7746,10 +7961,10 @@ where::
-y | --subscriber-name Onap subscriber name. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7800,10 +8015,10 @@ where::
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7859,10 +8074,10 @@ where::
-x | --customer-name Onap customer name. It is of type STRING.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7917,10 +8132,10 @@ where::
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -7981,10 +8196,10 @@ where::
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -8048,10 +8263,10 @@ where::
eb4a0d54-0e29-4174-8a3c-2c98e904a5f6.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -8105,10 +8320,10 @@ where::
b06576ca-74b8-42f2-815b-6f7b80f9941c.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -8156,10 +8371,10 @@ where::
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
@@ -8231,10 +8446,10 @@ where::
optional.
-u | --onap-username Onap user name. It is of type STRING. By default,
it is read from environment variable
- OPEN_USERNAME.
+ OPEN_CLI_USERNAME.
-p | --onap-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- OPEN_PASSWORD. Secured.
+ OPEN_CLI_PASSWORD. Secured.
-m | --host-url Onap host url. It is of type URL. By default, it
is read from environment variable OPEN_HOST_URL.
-h | --help Onap command help message. It is of type STRING.
diff --git a/docs/open_cli_schema_version_1_0.rst b/docs/open_cli_schema_version_1_0.rst
index 42053730..8b365861 100644
--- a/docs/open_cli_schema_version_1_0.rst
+++ b/docs/open_cli_schema_version_1_0.rst
@@ -485,7 +485,7 @@ name: host-username
long_option: host-username
- default_value: ${HOST_USERNAME}
+ default_value: ${OPEN_CLI_HOST_USERNAME}
is_optional: false
@@ -500,7 +500,7 @@ name: host-password
long_option: host-password
- default_value: ${HOST_PASSWORD}
+ default_value: ${OPEN_CLI_HOST_PASSWORD}
is_secured: true
@@ -518,7 +518,7 @@ name: host-url
is_optional: false
- default_value: ${HOST_URL}
+ default_value: ${OPEN_CLI_HOST_URL}
name: help
~~~~~~~~~~
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
index 64554682..b82dd16b 100644
--- a/docs/user_guide.rst
+++ b/docs/user_guide.rst
@@ -13,8 +13,8 @@ Provides unified commands to operate ONAP from Linux console.
Configure the following environment variables, before using it:
1. **OPEN_HOST_URL** - Onap Micro service bus(MSB) URL or a service URL
-2. **OPEN_USERNAME** - Onap user name
-3. **OPEN_PASSWORD** - Onap user password
+2. **OPEN_CLI_USERNAME** - Onap user name
+3. **OPEN_CLI_PASSWORD** - Onap user password
To Run a command
-----------------
diff --git a/framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java b/framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java
index 2f970b5f..f3b949f1 100644
--- a/framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java
+++ b/framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java
@@ -19,7 +19,7 @@ package org.onap.cli.fw.error;
import java.util.Set;
/*
- * ONAP command product version is invalid
+ * Open CLI command product version is invalid
*
*/
public class OnapCommandProductVersionInvalid extends OnapCommandException {
diff --git a/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java b/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java
index 7baae094..bcb404fe 100644
--- a/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java
+++ b/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java
@@ -1062,8 +1062,8 @@ public class OnapCommandUtils {
* help failed exception
*/
public static String help(OnapCommand cmd) throws OnapCommandHelpFailed {
- //mrkanag refactor onap name into oclip
- String help = "usage: onap " + cmd.getName();
+
+ String help = "usage: oclip " + cmd.getName();
// Add description
help += "\n\n" + cmd.getDescription();
diff --git a/framework/src/main/resources/default_input_parameters_http.yaml b/framework/src/main/resources/default_input_parameters_http.yaml
index 529053d0..81656ea0 100644
--- a/framework/src/main/resources/default_input_parameters_http.yaml
+++ b/framework/src/main/resources/default_input_parameters_http.yaml
@@ -5,14 +5,14 @@ parameters:
description: Host user name
short_option: u
long_option: host-username
- default_value: $s{env:HOST_USERNAME}
+ default_value: $s{env:OPEN_CLI_HOST_USERNAME}
is_optional: false
- name: host-password
type: string
description: Host user password
short_option: p
long_option: host-password
- default_value: $s{env:HOST_PASSWORD}
+ default_value: $s{env:OPEN_CLI_HOST_PASSWORD}
is_secured: true
is_optional: false
- name: host-url
@@ -21,7 +21,7 @@ parameters:
short_option: m
long_option: host-url
is_optional: false
- default_value: $s{env:HOST_URL}
+ default_value: $s{env:OPEN_CLI_HOST_URL}
- name: no-auth
type: bool
description: whether to authenticate user or not
diff --git a/framework/src/test/resources/sample-cmd-test-help.txt b/framework/src/test/resources/sample-cmd-test-help.txt
index 2523ce9b..fd36587d 100644
--- a/framework/src/test/resources/sample-cmd-test-help.txt
+++ b/framework/src/test/resources/sample-cmd-test-help.txt
@@ -1,4 +1,4 @@
-usage: onap sample-test
+usage: oclip sample-test
Onap sample command to test the command features
diff --git a/main/src/main/resources/onap-readme.txt b/main/src/main/resources/onap-readme.txt
index 39990700..ab4086b5 100644
--- a/main/src/main/resources/onap-readme.txt
+++ b/main/src/main/resources/onap-readme.txt
@@ -1,22 +1,22 @@
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:
-1. HOST_URL - Catalog service URL or a service URL
-2. HOST_USERNAME - Service user name
-3. HOST_PASSWORD - Service password
+1. OPEN_CLI_HOST_URL - Catalog service URL or a service URL
+2. OPEN_CLI_HOST_USERNAME - Service user name
+3. OPEN_CLI_HOST_PASSWORD - Service password
To know the CLI version, type onap [-v|--version]
To know the CLI usage, type onap [-h|--help]