From f9618be6f7dfaedb1001e74f6e8f71f364a75a7c Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam k00365106 Date: Fri, 27 Apr 2018 16:17:01 +0530 Subject: CLI HELP: vf-delete Change-Id: I25379ba8a87529083b54007a0400dff0d3bb0349 Issue-ID: CLI-100 Signed-off-by: Kanagaraj Manickam k00365106 --- docs/cmd_help_onap_beijing.rst | 77 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) (limited to 'docs') diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst index 9d3c533f..042f4e73 100644 --- a/docs/cmd_help_onap_beijing.rst +++ b/docs/cmd_help_onap_beijing.rst @@ -2737,3 +2737,80 @@ Error:: On error, it prints :::: + +vf-delete +---------------------------------------------------- + +usage: oclip vf-delete + +delete a VF (experimental) + +Product: onap-beijing +Service: so +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-e | --model-name] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-l | --cloud-region] [-b | --model-invariant-id] [-y | --service-instance-id] + [-z | --tenant-id] [-s | --long] [-D | --context] + [-g | --model-version] [-c | --model-uuid] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] [-x | --vf-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. + -e | --model-name model name available in SDC catalog. 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. + -l | --cloud-region Cloud region ID. It is of type STRING. By + default, it is . + -b | --model-invariant-id model invariant id for service in SDC catalog. 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 (uuid). 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 | --model-version model version of service (eg. 1.0). It is of type + STRING. By default, it is . + -c | --model-uuid model uuid for service in SDC catalog. 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. + -x | --vf-id id for vnf. It is of type STRING. By default, it + is . + + +Error:: + + On error, it prints :::: + -- cgit 1.2.3-korg