summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/cmd_help.rst280
-rw-r--r--docs/cmd_help_onap_beijing.rst773
2 files changed, 1053 insertions, 0 deletions
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst
index eece635e..b9f58539 100644
--- a/docs/cmd_help.rst
+++ b/docs/cmd_help.rst
@@ -109,3 +109,283 @@ Results::
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+
+
+[65] subscription-create
+-----------------------------------------------
+
+
+usage: oclip subscription-create
+
+Create a subscription of a customer for given service in specific cloud region in Onap
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-x | --customer-name]
+ [-z | --cloud-name] [-c | --cloud-tenant-id] [-s | --long]
+ [-D | --context] [-e | --service-type] [-u | --host-username]
+ [-a | --no-auth] [-p | --host-password] [-r | --cloud-region]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog whether to use given host-url directly without
+ looking into catalog, it will overrid the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify verify the command using available command sample
+ file and mocking file. By default it goes with
+ mock style. To enable the verification in real
+ time, set DISABLE_MOCKING=true in the context
+ param. It is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --customer-name Onap customer name. It is of type STRING. By
+ default, it is .
+ -z | --cloud-name Onap cloud name. It is of type STRING. By
+ default, it is .
+ -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. By
+ default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -e | --service-type Onap service type. It is of type STRING. By
+ default, it is .
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+ -r | --cloud-region Onap cloud region. It is of type STRING. By
+ default, it is .
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+[66] subscription-create-with-template
+-----------------------------------------------
+
+
+usage: oclip subscription-create-with-template
+
+Create a subscription of a customer with template
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-x | --customer-name]
+ [-r | --template] [-s | --long] [-D | --context]
+ [-e | --service-type] [-u | --host-username] [-a | --no-auth]
+ [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog whether to use given host-url directly without
+ looking into catalog, it will overrid the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify verify the command using available command sample
+ file and mocking file. By default it goes with
+ mock style. To enable the verification in real
+ time, set DISABLE_MOCKING=true in the context
+ param. It is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --customer-name Onap customer name. It is of type STRING. By
+ default, it is .
+ -r | --template template. It is of type JSON. It's recommended to
+ input the complete path of the file, which is
+ having the value for it.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -e | --service-type Onap service type. It is of type STRING. By
+ default, it is .
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+[67] subscription-delete
+-----------------------------------------------
+
+
+usage: oclip subscription-delete
+
+Delete the subscription for a given customer in Onap
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-x | --customer-name]
+ [-y | --service-type] [-s | --long] [-D | --context]
+ [-g | --resource-version] [-u | --host-username] [-a | --no-auth]
+ [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog whether to use given host-url directly without
+ looking into catalog, it will overrid the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify verify the command using available command sample
+ file and mocking file. By default it goes with
+ mock style. To enable the verification in real
+ time, set DISABLE_MOCKING=true in the context
+ param. It is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --customer-name Onap customer name. It is of type STRING. By
+ default, it is .
+ -y | --service-type Onap subscribtion id. It is of type STRING. By
+ default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -g | --resource-version Onap subscription resource version. It is of type
+ STRING. It is optional. By default, it is .
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+[68] subscription-list
+-----------------------------------------------
+
+
+usage: oclip subscription-list
+
+Lists the subscription for a given customer in Onap
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-x | --customer-name]
+ [-s | --long] [-D | --context] [-u | --host-username]
+ [-a | --no-auth] [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog whether to use given host-url directly without
+ looking into catalog, it will overrid the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify verify the command using available command sample
+ file and mocking file. By default it goes with
+ mock style. To enable the verification in real
+ time, set DISABLE_MOCKING=true in the context
+ param. It is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --customer-name Onap customer name. It is of type STRING. By
+ default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Results::
+
+ service-type Onap service type and is of type STRING.
+ resource-version Onap subscription resource version and is of type
+ STRING.
+ tenant Onap tenant name and is of type STRING.
+ region Onap region name and is of type STRING.
+ cloud Onap cloud name and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> \ No newline at end of file
diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst
index 03e1eda5..d322f682 100644
--- a/docs/cmd_help_onap_beijing.rst
+++ b/docs/cmd_help_onap_beijing.rst
@@ -1748,3 +1748,776 @@ Results::
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+tenant-create
+----------------------------------------------------
+
+usage: oclip tenant-create
+
+Create a tenant under given cloud region in Onap
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-x | --cloud]
+ [-z | --tenant-id] [-y | --region] [-s | --long]
+ [-D | --context] [-r | --tenant-name] [-u | --host-username]
+ [-a | --no-auth] [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --cloud Onap cloud. It is of type STRING. By default, it
+ is .
+ -z | --tenant-id Onap cloud tenant id. It is of type STRING. By
+ default, it is .
+ -y | --region Onap cloud region. It is of type STRING. By
+ default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -r | --tenant-name Onap cloud tenant name. It is of type STRING. By
+ default, it is .
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vf-create
+----------------------------------------------------
+
+usage: oclip vf-create
+
+Create a VF
+
+Product: onap-beijing
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-j | --service-model-invariant-id] [-k | --service-model-uuid] [-q | --service-model-name]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-V | --verify] [-v | --version] [-l | --cloud-region]
+ [-y | --service-instance-id] [-z | --tenant-id] [-c | --vf-model-uuid]
+ [-o | --instance-name] [-s | --long] [-e | --vf-model-name]
+ [-g | --vf-model-version] [-b | --vf-model-invariant-id] [-a | --no-auth]
+ [-n | --service-model-version] [-p | --host-password] [-m | --host-url]
+ [-C | --no-catalog] [-i | --vf-model-customization-id] [-d | --debug]
+ [-D | --context] [-w | --product-family] [-u | --host-username]
+
+where::
+
+ -j | --service-model-invariant-id model invariant id. It is of type STRING. By
+ default, it is .
+ -k | --service-model-uuid model name version id. It is of type STRING. By
+ default, it is .
+ -q | --service-model-name service model name. It is of type STRING. By
+ default, it is .
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -l | --cloud-region cloud region identifier. It is of type STRING. By
+ default, it is .
+ -y | --service-instance-id unique id for service instance. It is of type
+ STRING. By default, it is .
+ -z | --tenant-id openstack tenant id. It is of type STRING. By
+ default, it is .
+ -c | --vf-model-uuid model uuid for vf. It is of type STRING. By
+ default, it is .
+ -o | --instance-name service instance name. It is of type STRING. By
+ default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -e | --vf-model-name vf model name. It is of type STRING. By default,
+ it is .
+ -g | --vf-model-version vf model version. It is of type STRING. By
+ default, it is .
+ -b | --vf-model-invariant-id vf model invariant id. It is of type STRING. By
+ default, it is .
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -n | --service-model-version service model version. It is of type STRING. By
+ default, it is .
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -i | --vf-model-customization-id vf model customization id. It is of type STRING.
+ By default, it is .
+ -d | --debug Enable debug output. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -w | --product-family service type for serivce (e.g. vLB). It is of
+ type STRING. By default, it is .
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+
+
+Results::
+
+ vf-id id for the created vnf and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vf-list
+----------------------------------------------------
+
+usage: oclip vf-list
+
+List created VF instances for a service instance
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-x | --customer-name]
+ [-y | --service-type] [-s | --long] [-D | --context]
+ [-z | --service-id] [-u | --host-username] [-a | --no-auth]
+ [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --customer-name customer name. It is of type STRING. By default,
+ it is .
+ -y | --service-type service subscription type. It is of type STRING.
+ By default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -z | --service-id service ID. It is of type STRING. By default, it
+ is .
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Results::
+
+ vf-id VF ID for the given service and is of type STRING.
+ vf-name VF name and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vf-model-create
+----------------------------------------------------
+
+usage: oclip vf-model-create
+
+Create Virtual function from Vendor Software Product
+
+Product: onap-beijing
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-y | --description]
+ [-g | --vsp-version] [-x | --name] [-s | --long]
+ [-D | --context] [-z | --vendor-name] [-u | --host-username]
+ [-a | --no-auth] [-p | --host-password] [-b | --vsp-id]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -y | --description Description for VF. It is of type STRING. It is
+ optional. By default, it is .
+ -g | --vsp-version VSP version. It is of type STRING. It is
+ optional. By default, it is .
+ -x | --name Onap VF Name. It is of type STRING. By default,
+ it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -z | --vendor-name Vendor name. It is of type STRING. It is
+ optional. By default, it is .
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+ -b | --vsp-id VSP ID. It is of type STRING. It is optional. By
+ default, it is .
+
+
+Results::
+
+ ID VF ID and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vfmodule-create
+----------------------------------------------------
+
+usage: oclip vfmodule-create
+
+Create a VF module
+
+Product: onap-beijing
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-V | --verify] [-v | --version] [-l | --cloud-region]
+ [-x | --service-model-name] [-j | --service-id] [-z | --service-model-version]
+ [-i | --module-name] [-o | --vf-model-version] [-k | --vf-model-invariant-id]
+ [-s | --long] [-g | --vfmodule-version] [-r | --service-model-invariant-id]
+ [-n | --vf-model-name] [-a | --no-auth] [-w | --service-model-uuid]
+ [-p | --host-password] [-m | --host-url] [-C | --no-catalog]
+ [-d | --debug] [-b | --vfmodule-invariant-id] [-c | --vfmodule-uuid]
+ [-A | --vf-model-uuid] [-y | --vf-id] [-D | --context]
+ [-B | --tenant-id] [-e | --vfmodule-name] [-q | --vf-model-customization-id]
+ [-u | --host-username]
+
+where::
+
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -l | --cloud-region cloud region identifier. It is of type STRING. By
+ default, it is .
+ -x | --service-model-name service model name. It is of type STRING. By
+ default, it is .
+ -j | --service-id unique id for service. It is of type STRING. By
+ default, it is .
+ -z | --service-model-version service model version. It is of type STRING. By
+ default, it is .
+ -i | --module-name vfmodule name. It is of type STRING. By default,
+ it is .
+ -o | --vf-model-version vf model version. It is of type STRING. By
+ default, it is .
+ -k | --vf-model-invariant-id vf model invariant id. It is of type STRING. By
+ default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -g | --vfmodule-version vf module version. It is of type STRING. By
+ default, it is .
+ -r | --service-model-invariant-id model invariant id. It is of type STRING. By
+ default, it is .
+ -n | --vf-model-name vf model name. It is of type STRING. By default,
+ it is .
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -w | --service-model-uuid model name version id. It is of type STRING. By
+ default, it is .
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -b | --vfmodule-invariant-id vfmodule model invariant id. It is of type
+ STRING. By default, it is .
+ -c | --vfmodule-uuid model uuid for vfmodule. It is of type STRING. By
+ default, it is .
+ -A | --vf-model-uuid model uuid for vf. It is of type STRING. By
+ default, it is .
+ -y | --vf-id unique id for related VF. It is of type STRING.
+ By default, it is .
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -B | --tenant-id openstack tenant id. It is of type STRING. By
+ default, it is .
+ -e | --vfmodule-name vfmodule model name. It is of type STRING. By
+ default, it is .
+ -q | --vf-model-customization-id vf model customization id. This can be obtained
+ using SDC portal (Home -> service:xxx ->
+ Composition -> click on VF for customization id).
+ It is of type STRING. By default, it is .
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+
+
+Results::
+
+ vfmodule-id id for the created vnf and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vlm-aggreement-create
+----------------------------------------------------
+
+usage: oclip vlm-aggreement-create
+
+Create license aggreement
+
+Product: onap-beijing
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-y | --vlm-id] [-C | --no-catalog]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-V | --verify] [-v | --version] [-d | --debug]
+ [-z | --description] [-x | --name] [-g | --vlm-feature-group-id]
+ [-s | --long] [-D | --context] [-u | --host-username]
+ [-a | --no-auth] [-e | --vlm-version] [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -y | --vlm-id License Model ID. It is of type STRING. By
+ default, it is .
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -z | --description Description for aggreement. It is of type STRING.
+ By default, it is .
+ -x | --name aggreement name. It is of type STRING. By
+ default, it is .
+ -g | --vlm-feature-group-id VLM feature group. It is of type STRING. By
+ default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -e | --vlm-version License Model version. It is of type STRING. By
+ default, it is .
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Results::
+
+ ID aggreement ID and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vlm-entitlement-pool-create
+----------------------------------------------------
+
+usage: oclip vlm-entitlement-pool-create
+
+Create Entitlement Pool
+
+Product: onap-beijing
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-y | --vlm-id] [-C | --no-catalog]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-V | --verify] [-v | --version] [-d | --debug]
+ [-z | --description] [-k | --manufacture-reference-number] [-x | --name]
+ [-g | --operational-scope] [-s | --long] [-D | --context]
+ [-u | --host-username] [-a | --no-auth] [-e | --vlm-version]
+ [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -y | --vlm-id License Model ID. It is of type STRING. By
+ default, it is .
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -z | --description Description for Entitlement Pool. It is of type
+ STRING. By default, it is .
+ -k | --manufacture-reference-number Manufature Reference Number. It is of type
+ STRING. By default, it is .
+ -x | --name Entitlement Pool name. It is of type STRING. By
+ default, it is .
+ -g | --operational-scope Operational Scope. It is of type STRING.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -e | --vlm-version License Model version. It is of type STRING. By
+ default, it is .
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Results::
+
+ ID Entitlement Pool ID and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vlm-key-group-list
+----------------------------------------------------
+
+usage: oclip vlm-key-group-list
+
+key group list in a license model
+
+Product: onap-beijing
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-V | --verify] [-v | --version] [-d | --debug]
+ [-x | --vlm-id] [-s | --long] [-D | --context]
+ [-u | --host-username] [-a | --no-auth] [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -y | --vlm-version License Model version. It is of type STRING. By
+ default, it is .
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --vlm-id License Model ID. It is of type STRING. By
+ default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Results::
+
+ ID Feature group ID and is of type STRING.
+ name Feature group name and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vnf-create-with-template
+----------------------------------------------------
+
+usage: oclip vnf-create-with-template
+
+Create a pnf with a template. this is flexible approch to create VNF , all the parameters are in template json file
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-r | --template]
+ [-i | --vnf-id] [-s | --long] [-D | --context]
+ [-u | --host-username] [-a | --no-auth] [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -r | --template template. It is of type JSON. It's recommended to
+ input the complete path of the file, which is
+ having the value for it.
+ -i | --vnf-id vnf-id. It is of type STRING. By default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+vnfm-show
+----------------------------------------------------
+
+usage: oclip vnfm-show
+
+Show the VNFM in Onap
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ [-v | --version] [-d | --debug] [-x | --vnfm-id]
+ [-s | --long] [-D | --context] [-u | --host-username]
+ [-a | --no-auth] [-p | --host-password]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --vnfm-id Onap VNFM unique id. It is of type UUID.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -u | --host-username Host user name. It is of type STRING. By default,
+ it is read from environment variable
+ OPEN_CLI_HOST_USERNAME.
+ -a | --no-auth Whether to authenticate user or not. It is of
+ type BOOL.
+ -p | --host-password Host user password. It is of type STRING. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_PASSWORD. Secured.
+
+
+Results::
+
+ name Onap vnfm name and is of type STRING.
+ type Onap vnfm type and is of type STRING.
+ vendor Onap vnfm vendor and is of type STRING.
+ version Onap vnfm version and is of type STRING.
+ url Onap vnfm url and is of type STRING.
+ username Onap vnfm username and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+