diff options
52 files changed, 7837 insertions, 344 deletions
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst index b9f58539..eece635e 100644 --- a/docs/cmd_help.rst +++ b/docs/cmd_help.rst @@ -109,283 +109,3 @@ 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 d322f682..db2b2e33 100644 --- a/docs/cmd_help_onap_beijing.rst +++ b/docs/cmd_help_onap_beijing.rst @@ -2521,3 +2521,2897 @@ Error:: On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + +vsp-create +---------------------------------------------------- + +usage: oclip vsp-create + +Create Vendor Software Product + +Product: onap-beijing +Service: sdc +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-j | --vlm-feature-group-id] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-e | --vlm-vendor] [-b | --vsp-subcategory] [-z | --vsp-category] + [-x | --vsp-name] [-s | --long] [-D | --context] + [-y | --vsp-description] [-i | --vlm-agreement-id] [-c | --vlm-version] + [-u | --host-username] [-a | --no-auth] [-g | --vlm-id] + [-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. + -j | --vlm-feature-group-id Feature Group 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. + -e | --vlm-vendor License Model vendor. It is of type STRING. By + default, it is . + -b | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is + optional. + -z | --vsp-category Category of the VSP. It is of type STRING. It is + optional. + -x | --vsp-name Onap VSP 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. + -y | --vsp-description Description for VSP. It is of type STRING. It is + optional. By default, it is . + -i | --vlm-agreement-id License Agreement ID. It is of type STRING. By + default, it is . + -c | --vlm-version License version. It is of type STRING. 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. + -g | --vlm-id License Model 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. + + +Results:: + + ID VSP ID and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vsp-submit +---------------------------------------------------- + +usage: oclip vsp-submit + +Submit 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] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-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 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 | --vsp-id Onap VSP 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. + -y | --vsp-version VSP version. 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> + + +tenant-delete +---------------------------------------------------- + +usage: oclip tenant-delete + +Delete 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] [-r | --resource-version] + [-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 | --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 . + -r | --resource-version Onap cloud tenant version. It is of type UUID. It + is optional. + -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> + + +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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vf-model-certify-complete +---------------------------------------------------- + +usage: oclip vf-model-certify-complete + +Complete certifying Virtual function + +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] [-b | --vf-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. + -b | --vf-id VF ID. It is of type STRING. It is optional. 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> + + +vf-model-list +---------------------------------------------------- + +usage: oclip vf-model-list + +List the VF resource model in SDC + +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] [-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. + -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:: + + uuid UUID and is of type STRING. + uniqueid UUID and is of type STRING. + invariant-uuid Invariant UUID and is of type STRING. + name Name and is of type STRING. + version version and is of type STRING. + status status and is of type STRING. + description description and is of type STRING. + vsp-uuid VSP uuid and is of type STRING. + vsp-version VSP version and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vfmodule-delete +---------------------------------------------------- + +usage: oclip vfmodule-delete + +delete a VF module (experimental) + +Product: onap-beijing +Service: so +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] [-l | --cloud-region] + [-j | --service-id] [-z | --tenant-id] [-y | --vf-id] + [-k | --vf-model-invariant-id] [-s | --long] [-D | --context] + [-g | --vfmodule-version] [-x | --vfmodule-id] [-e | --vfmodule-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. + -l | --cloud-region cloud region identifier. 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 | --tenant-id openstack tenant id. 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 . + -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. + -D | --context command context. It is of type MAP. It is + optional. + -g | --vfmodule-version vf module version. It is of type STRING. By + default, it is . + -x | --vfmodule-id VF module 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 . + -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> + + +vlm-aggreement-list +---------------------------------------------------- + +usage: oclip vlm-aggreement-list + +List license aggreement + +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 aggreement ID and is of type STRING. + name aggreement name and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vlm-entitlement-pool-list +---------------------------------------------------- + +usage: oclip vlm-entitlement-pool-list + +entitlement pool 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> + + +vlm-list +---------------------------------------------------- + +usage: oclip vlm-list + +List License Model + +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] [-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. + -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 License ID and is of type UUID. + vendor-name Vendor Name and is of type STRING. + vlm-version VLM version and is of type STRING. + status status and is of type STRING. + description License description and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vnf-delete +---------------------------------------------------- + +usage: oclip vnf-delete + +Delete vnf from 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] [-i | --vnf-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] [-b | --resource-version] + +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. + -i | --vnf-id Onap 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. + -b | --resource-version Onap vnf resource version. It is of type UUID. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vnfm-unregister +---------------------------------------------------- + +usage: oclip vnfm-unregister + +Un-register a 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] [-y | --resource-version] + [-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. + -y | --resource-version Onap vim resource version. It is of type STRING. + It is optional. By default, it is . + -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. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vsp-list +---------------------------------------------------- + +usage: oclip vsp-list + +List of the Vendor Software Products + +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] [-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. + -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 VSP ID and is of type STRING. + name VSP Name and is of type STRING. + vendor-name Vendor name and is of type STRING. + version Version and is of type STRING. + status status and is of type STRING. + license-id license aggreement and is of type STRING. + license-version license version and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vsp-validate +---------------------------------------------------- + +usage: oclip vsp-validate + +Validated the uploaded 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] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-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 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 | --vsp-id Onap VSP 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. + -y | --vsp-version VSP version. 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:: + + status Validation status and is of type STRING. + errors Validation messages and is of type JSON. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +tenant-list +---------------------------------------------------- + +usage: oclip tenant-list + +Lists the tenants 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] + [-y | --region] [-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 | --cloud Onap cloud. 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. + -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:: + + tenant-id Onap tenant-id and is of type STRING. + tenant-name Onap tenant name and is of type STRING. + resource-version Onap tenant resource version and is of type + STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vf-model-certify-request +---------------------------------------------------- + +usage: oclip vf-model-certify-request + +Request for certifying Virtual function + +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] [-b | --vf-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. + -b | --vf-id VF ID. It is of type STRING. It is optional. 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> + + +vf-module-create +---------------------------------------------------- + +usage: oclip vf-module-create + +Create a VF Module + +Product: onap-beijing +Service: so +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] + [-w | --tenant-id] [-v | --version] [-d | --debug] + [-y | --vnf-instace-id] [-z | --parenet-service-model] [-x | --service-instace-id] + [-l | --lcp-cloudregion-id] [-s | --long] [-D | --context] + [-i | --instance-name] [-u | --host-username] [-r | --supress-rollback] + [-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. + -w | --tenant-id openstack tenant id (uuid). It is of type STRING. + By default, it is . + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --vnf-instace-id vnf instance id. It is of type STRING. By + default, it is . + -z | --parenet-service-model parent service model name. It is of type STRING. + By default, it is . + -x | --service-instace-id unique id for service instance. It is of type + STRING. By default, it is . + -l | --lcp-cloudregion-id AIC LCP node location identifier. 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. + -i | --instance-name service instance 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. + -r | --supress-rollback rollback changes if instantiation fails. It is of + type BOOL. It is optional. + -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> + + +vim-list +---------------------------------------------------- + +usage: oclip vim-list + +List the configured vims + +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-name] + [-s | --long] [-D | --context] [-y | --region-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-name Onap cloud 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. + -y | --region-name Onap region 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. + + +Results:: + + vim-id Onap vim id and is of type STRING. + name Onap vim name and is of type STRING. + type Onap vim type and is of type STRING. + vendor Onap vim vendor and is of type STRING. + version Onap vim version and is of type STRING. + url Onap vim url and is of type STRING. + username Onap vim username and is of type STRING. + cloud-domain Onap vim cloud domain and is of type STRING. + default-tenant Onap vim tenant and is of type STRING. + resource-version Onap vim resource version and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vlm-checkin +---------------------------------------------------- + +usage: oclip vlm-checkin + +Checkin Vendor 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 VLM 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 Onap VLM 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> + + +vlm-feature-group-create +---------------------------------------------------- + +usage: oclip vlm-feature-group-create + +Create feature group 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] [-c | --part-number] [-v | --version] + [-d | --debug] [-z | --description] [-b | --vlm-entitle-pool-id] + [-k | --manufacture-reference-number] [-x | --name] [-g | --vlm-key-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. + -c | --part-number Part number. It is of type STRING. By default, it + is . + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -z | --description Description for feature group. It is of type + STRING. By default, it is . + -b | --vlm-entitle-pool-id VLM 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 Feature group name. It is of type STRING. By + default, it is . + -g | --vlm-key-group-id VLM keygroup. 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 Feature group ID and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vlm-revert +---------------------------------------------------- + +usage: oclip vlm-revert + +Revert Vendor 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 VLM 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 Onap VLM 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> + + +vnf-list +---------------------------------------------------- + +usage: oclip vnf-list + +Lists the vnfs + +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] [-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. + -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:: + + vnf-name Onap vnf name and is of type STRING. + vnf-id Onap vnf id and is of type STRING. + vnf-type Onap vnf-type and is of type STRING. + in-maint Onap in-maint and is of type STRING. + resource-version Onap resource-version and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vsp-add-artifact +---------------------------------------------------- + +usage: oclip vsp-add-artifact + +Upload the CSAR file to VSP + +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] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-z | --vsp-file] + +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 | --vsp-id Onap VSP 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. + -y | --vsp-version Onap VSP version. It is of type STRING. By + default, it is . + -z | --vsp-file CSAR File path. It is of type BINARY. By default, + it is . + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vsp-package +---------------------------------------------------- + +usage: oclip vsp-package + +Package 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] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-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 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 | --vsp-id Onap VSP 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. + -y | --vsp-version VSP version. 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-model-checkin +---------------------------------------------------- + +usage: oclip vf-model-checkin + +Checkin Virtual function + +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] [-b | --vf-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. + -b | --vf-id VF ID. It is of type STRING. It is optional. 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> + + +vf2vfmodule-model-list +---------------------------------------------------- + +usage: oclip vf2vfmodule-model-list + +List the VF modules in a given VF model in SDC + +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] [-z | --vf-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. + -z | --vf-id VF 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. + -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:: + + vsp-uuid VSP uuid and is of type STRING. + vsp-version VSP version and is of type STRING. + module-uuid UUID and is of type STRING. + module-invariant-uuid Invariant UUID and is of type STRING. + module-name name and is of type STRING. + module-version version and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vim-unregister +---------------------------------------------------- + +usage: oclip vim-unregister + +Un-register a VIM under from 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-name] + [-s | --long] [-D | --context] [-y | --region-name] + [-u | --host-username] [-a | --no-auth] [-z | --vim-id] + [-p | --host-password] [-b | --resource-version] + +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-name Onap cloud 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. + -y | --region-name Onap region 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. + -z | --vim-id Onap VIM unique id. It is of type UUID. + -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 | --resource-version Onap vim resource version. It is of type STRING. + It is optional. By default, it is . + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vlm-create +---------------------------------------------------- + +usage: oclip vlm-create + +Create License Model + +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] + [-s | --long] [-D | --context] [-x | --vendor-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. + -y | --description Description for License Model. It is of type + STRING. It is optional. 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. + -x | --vendor-name vendor 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. + + +Results:: + + ID License Model ID and is of type UUID. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vlm-key-group-create +---------------------------------------------------- + +usage: oclip vlm-key-group-create + +Create License Key Group + +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] [-z | --description] + [-x | --name] [-s | --long] [-D | --context] + [-y | --type] [-c | --vlm-id] [-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. + -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 License Key Group. It is of type + STRING. It is optional. By default, it is . + -x | --name 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. + -y | --type type of group (Universal, unique, one-time). It + is of type STRING. + -c | --vlm-id License Model 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. + -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 License Model ID and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vnf-create +---------------------------------------------------- + +usage: oclip vnf-create + +Create a vnf directly into AAI. + +Product: onap-beijing +Service: aai +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-n | --name] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-w | --in-maint] [-i | --vnf-id] [-s | --long] + [-D | --context] [-z | --vnf-type] [-u | --host-username] + [-r | --relationship] [-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. + -n | --name vnf-name. 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. + -w | --in-maint Used to indicate whether or not this object is in + maintenance mode (maintenance mode = true). It is + of type BOOL. It is optional. + -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. + -z | --vnf-type vnf-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. + -r | --relationship relationship. It is of type JSON. It's + recommended to input the complete path of the + file, which is having the value for it. It is + optional. + -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-register +---------------------------------------------------- + +usage: oclip vnfm-register + +Register a 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] + [-e | --vendor] [-v | --version] [-d | --debug] + [-y | --vnfm-id] [-c | --type] [-x | --vim-id] + [-s | --long] [-D | --context] [-b | --name] + [-i | --username] [-j | --password] [-u | --host-username] + [-g | --url] [-a | --no-auth] [-q | --vnfm-version] + [-p | --host-password] [-z | --certificate-url] + +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. + -e | --vendor Onap VNFM vendor. It is of type STRING. By + default, it is . + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --vnfm-id Onap VNFM unique id. It is of type UUID. + -c | --type Onap VNFM type. It is of type STRING. By default, + it is . + -x | --vim-id Onap VIM 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. + -b | --name Onap VNFM name. It is of type STRING. By default, + it is . + -i | --username Onap VNFM username. It is of type STRING. By + default, it is . + -j | --password Onap VNFM password. 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. + -g | --url Onap VNFM URL. It is of type STRING. By default, + it is . + -a | --no-auth Whether to authenticate user or not. It is of + type BOOL. + -q | --vnfm-version Onap VNFM 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. + -z | --certificate-url Onap VNFM certificate-url. It is of type STRING. + It is optional. By default, it is . + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vsp-checkout +---------------------------------------------------- + +usage: oclip vsp-checkout + +Checkout 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] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-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 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 | --vsp-id Onap VSP 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. + -y | --vsp-version VSP version. 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> + + +vsp-show +---------------------------------------------------- + +usage: oclip vsp-show + +Details of the 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] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-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 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 | --vsp-id Onap VSP 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. + -y | --vsp-version Onap VSP version. 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:: + + 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. + vendor-name Vendor name and is of type STRING. + vendor-id Vendor id and is of type STRING. + version Version and is of type STRING. + status status and is of type STRING. + license-id license aggreement and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vf-model-certify-start +---------------------------------------------------- + +usage: oclip vf-model-certify-start + +Start certifying Virtual function + +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] [-b | --vf-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. + -b | --vf-id VF ID. It is of type STRING. It is optional. 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> + + +vf-show +---------------------------------------------------- + +usage: oclip vf-show + +Show details for VF + +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] [-s | --long] + [-D | --context] [-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. + -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. + -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. + -x | --vf-id VF identifier. It is of type STRING. By default, + it is . + + +Results:: + + vf-id VF ID for the given service and is of type STRING. + vf-name VF name and is of type STRING. + vf-type VF name and is of type STRING. + model-invariant-id VF name and is of type STRING. + model-uuid model uuid and is of type STRING. + model-customization-id Model customization id and is of type STRING. + service-id Service ID of parent service and is of type + STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vim-register +---------------------------------------------------- + +usage: oclip vim-register + +Register a VIM under a given cloud region in Onap + +Product: onap-beijing +Service: aai +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-e | --vendor] [-v | --version] + [-x | --cloud-name] [-s | --long] [-k | --ssl-cacert] + [-y | --region-name] [-b | --name] [-j | --password] + [-a | --no-auth] [-n | --cloud-domain] [-z | --vim-id] + [-p | --host-password] [-m | --host-url] [-C | --no-catalog] + [-d | --debug] [-q | --vim-version] [-l | --ssl-insecure] + [-c | --type] [-o | --default-tenant] [-D | --context] + [-i | --username] [-u | --host-username] [-g | --url] + +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. + -e | --vendor Onap VIM vendor. It is of type STRING. By + default, it is . + -v | --version print service version. It is of type BOOL. + -x | --cloud-name Onap cloud 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. + -k | --ssl-cacert Onap VIM SSL certificate. It is of type TEXT. It + is optional. By default, it is . + -y | --region-name Onap region name. It is of type STRING. By + default, it is . + -b | --name Onap VIM name. It is of type STRING. By default, + it is . + -j | --password Onap VIM password. It is of type STRING. By + default, it is . + -a | --no-auth Whether to authenticate user or not. It is of + type BOOL. + -n | --cloud-domain Onap VIM cloud domain. It is of type STRING. By + default, it is . + -z | --vim-id Onap VIM unique id. It is of type UUID. + -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. + -q | --vim-version Onap VIM version. It is of type STRING. By + default, it is . + -l | --ssl-insecure Onap VIM insecure. It is of type BOOL. It is + optional. + -c | --type Onap VIM type. It is of type STRING. By default, + it is . + -o | --default-tenant Onap VIM default tenant. It is of type STRING. By + default, it is . + -D | --context command context. It is of type MAP. It is + optional. + -i | --username Onap VIM username. 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. + -g | --url Onap VIM URL. It is of type STRING. By default, + it is . + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vlm-checkout +---------------------------------------------------- + +usage: oclip vlm-checkout + +Checkout Vendor 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 VLM 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 Onap VLM 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> + + +vlm-feature-group-list +---------------------------------------------------- + +usage: oclip vlm-feature-group-list + +Feature 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> + + +vlm-submit +---------------------------------------------------- + +usage: oclip vlm-submit + +Submit Vendor 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 VLM 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 Onap VLM 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-list +---------------------------------------------------- + +usage: oclip vnfm-list + +List the configured vnfm + +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] [-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. + -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:: + + vnfm-id Onap vnfm id and is of type STRING. + vim-id Onap vnfm id and is of type STRING. + certificate-url Onap vnfm certificate-url and is of type STRING. + resource-version Onap vnfm resource version and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + +vsp-checkin +---------------------------------------------------- + +usage: oclip vsp-checkin + +Checkin 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] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-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 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 | --vsp-id Onap VSP 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. + -y | --vsp-version VSP version. 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> + + +vsp-revert +---------------------------------------------------- + +usage: oclip vsp-revert + +Revert 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] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-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 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 | --vsp-id Onap VSP 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. + -y | --vsp-version VSP version. 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> + diff --git a/docs/cookbook.rst b/docs/cookbook.rst index a21e2015..d5692b6f 100644 --- a/docs/cookbook.rst +++ b/docs/cookbook.rst @@ -16,7 +16,7 @@ To Run OCLIP on local docker machine 2. Pull cli docker image and run locally:: - docker run -d --name oclip -e CLI_MODE=daemon -p 8080:9090 -p 8080:80 nexus3.onap.org:10001/onap/cli:2.0-STAGING-latest + docker run -d --name oclip -e OPEN_CLI_MODE=daemon -p 8080:9090 -p 8080:80 nexus3.onap.org:10001/onap/cli:2.0-STAGING-latest Access the CLI console ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/index.rst b/docs/index.rst index 3132ae62..bb578648 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,9 @@ ONAP CLI :blue:`One Command to command whole ONAP !` +Introduction +------------- + Both Information and Communication Technology customers prefer Command Line Interface (CLI) over Graphical user interface (GUI) in many situations such as automation, Devops, CI&CD. So CLI is always been as integral part @@ -27,6 +30,11 @@ the commands for following ONAP functionalities: * Policy management * VNF/PNF management +Table of contents +------------------ + +Following guidelines provides detailed information about CLI. + .. toctree:: :maxdepth: 1 diff --git a/docs/release-notes.rst b/docs/release-notes.rst index cdacebbb..13f6ed0a 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -25,9 +25,9 @@ In addition, it made following changes to OCS 1.0 * http profile is enabled with --- service to capture micro-service catalog and auth information +# service to capture micro-service catalog and auth information --- body section could be customized using context +# body section could be customized using context * New default parameters verify and context are added. diff --git a/framework/src/main/java/org/onap/cli/fw/cmd/OnapCommand.java b/framework/src/main/java/org/onap/cli/fw/cmd/OnapCommand.java index aa04d556..d3264508 100644 --- a/framework/src/main/java/org/onap/cli/fw/cmd/OnapCommand.java +++ b/framework/src/main/java/org/onap/cli/fw/cmd/OnapCommand.java @@ -67,7 +67,7 @@ public abstract class OnapCommand { this.addDefaultSchemas(OnapCommandConstants.DEFAULT_PARAMETER_FILE_NAME); } - public List<String> getSchemas() throws OnapCommandException { + public List<String> getSchemas() { List<String> schemas = new ArrayList<>(); schemas.addAll(this.defaultSchemas); schemas.add(this.getSchemaName()); diff --git a/framework/src/main/java/org/onap/cli/fw/output/print/OnapCommandPrint.java b/framework/src/main/java/org/onap/cli/fw/output/print/OnapCommandPrint.java index 019ce5c6..fd1ddbaf 100644 --- a/framework/src/main/java/org/onap/cli/fw/output/print/OnapCommandPrint.java +++ b/framework/src/main/java/org/onap/cli/fw/output/print/OnapCommandPrint.java @@ -32,7 +32,6 @@ import org.onap.cli.fw.conf.OnapCommandConstants; import org.onap.cli.fw.error.OnapCommandOutputPrintingFailed; import org.onap.cli.fw.output.OnapCommandPrintDirection; -import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.dataformat.yaml.YAMLMapper; diff --git a/framework/src/main/java/org/onap/cli/fw/registrar/OnapCommandRegistrar.java b/framework/src/main/java/org/onap/cli/fw/registrar/OnapCommandRegistrar.java index 34dc6b6d..6ea1931a 100644 --- a/framework/src/main/java/org/onap/cli/fw/registrar/OnapCommandRegistrar.java +++ b/framework/src/main/java/org/onap/cli/fw/registrar/OnapCommandRegistrar.java @@ -56,7 +56,7 @@ import java.util.Set; */ public class OnapCommandRegistrar { - private static Logger LOG = LoggerFactory.getLogger(OnapCommandRegistrar.class); + private static Logger log = LoggerFactory.getLogger(OnapCommandRegistrar.class); private Map<String, Class<? extends OnapCommand>> registry = new HashMap<>(); @@ -113,10 +113,9 @@ public class OnapCommandRegistrar { * * @param name Command Name * @param cmd Command Class - * @throws OnapCommandInvalidRegistration Invalid registration exception * @throws OnapCommandRegistrationProductInfoMissing */ - private void register(String name, String version, Class<? extends OnapCommand> cmd) throws OnapCommandInvalidRegistration, OnapCommandRegistrationProductInfoMissing { + private void register(String name, String version, Class<? extends OnapCommand> cmd) throws OnapCommandRegistrationProductInfoMissing { if (version == null || version.isEmpty()) { throw new OnapCommandRegistrationProductInfoMissing(name); } @@ -278,7 +277,7 @@ public class OnapCommandRegistrar { for (OnapCommandSchemaInfo schema : schemas) { if (schema.isIgnore()) { - LOG.info("Ignoring schema " + schema.getSchemaURI()); + log.info("Ignoring schema " + schema.getSchemaURI()); continue; } @@ -288,7 +287,7 @@ public class OnapCommandRegistrar { } else if (plugins.containsKey(schema.getSchemaProfile())) { this.register(schema.getCmdName(), schema.getProduct(), plugins.get(schema.getSchemaProfile())); } else { - LOG.info("Ignoring schema " + schema.getSchemaURI()); + log.info("Ignoring schema " + schema.getSchemaURI()); } } } diff --git a/framework/src/main/java/org/onap/cli/fw/schema/OnapCommandSchemaInfo.java b/framework/src/main/java/org/onap/cli/fw/schema/OnapCommandSchemaInfo.java index 2cd9458a..a4703256 100644 --- a/framework/src/main/java/org/onap/cli/fw/schema/OnapCommandSchemaInfo.java +++ b/framework/src/main/java/org/onap/cli/fw/schema/OnapCommandSchemaInfo.java @@ -18,6 +18,7 @@ package org.onap.cli.fw.schema; import java.util.ArrayList; import java.util.List; +import java.util.Objects; import org.onap.cli.fw.cmd.OnapCommandType; import org.onap.cli.fw.conf.OnapCommandConstants; @@ -145,6 +146,18 @@ public class OnapCommandSchemaInfo implements Comparable<OnapCommandSchemaInfo> @Override public boolean equals(Object obj) { + if (obj == null) + return false; + + if (this.getClass() != obj.getClass()) + return false; + return this.compareTo((OnapCommandSchemaInfo) obj) == 0; } + + + @Override + public int hashCode() { + return Objects.hashCode(this.cmdName); + } } diff --git a/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandDiscoveryUtils.java b/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandDiscoveryUtils.java index b10629f4..26d49650 100644 --- a/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandDiscoveryUtils.java +++ b/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandDiscoveryUtils.java @@ -252,7 +252,7 @@ public class OnapCommandDiscoveryUtils { try { resourceMap = loadYaml(resource); } catch (OnapCommandException e) { - OnapCommandUtils.LOG.error("Ignores invalid schema " + resource.getURI().toString(), e); + OnapCommandUtils.log.error("Ignores invalid schema " + resource.getURI().toString(), e); continue; } @@ -263,14 +263,14 @@ public class OnapCommandDiscoveryUtils { Object obj = resourceMap.get(OPEN_CLI_SCHEMA_VERSION); if (obj == null) { - OnapCommandUtils.LOG.info("Invalid Schema yaml " + schema.getSchemaURI()); + OnapCommandUtils.log.info("Invalid Schema yaml " + schema.getSchemaURI()); continue; } schema.setVersion(obj.toString()); if (!schema.getVersion().equalsIgnoreCase(OnapCommandConstants.OPEN_CLI_SCHEMA_VERSION_VALUE_1_0)) { - OnapCommandUtils.LOG.info("Unsupported Schema version found " + schema.getSchemaURI()); + OnapCommandUtils.log.info("Unsupported Schema version found " + schema.getSchemaURI()); continue; } @@ -331,12 +331,12 @@ public class OnapCommandDiscoveryUtils { Object sampleVersion = infoMap.get(OPEN_CLI_SAMPLE_VERSION); if (sampleVersion == null) { - OnapCommandUtils.LOG.info("Invalid Sample yaml " + sampleResourse.getURI().toString()); + OnapCommandUtils.log.info("Invalid Sample yaml " + sampleResourse.getURI().toString()); return; } if (!sampleVersion.toString().equalsIgnoreCase(OnapCommandConstants.OPEN_CLI_SAMPLE_VERSION_VALUE_1_0)) { - OnapCommandUtils.LOG.info("Unsupported Sample version found " + sampleResourse.getURI().toString()); + OnapCommandUtils.log.info("Unsupported Sample version found " + sampleResourse.getURI().toString()); return; } 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 db89e067..879e6289 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 @@ -51,7 +51,7 @@ import com.jayway.jsonpath.JsonPath; */ public class OnapCommandUtils { - static Logger LOG = LoggerFactory.getLogger(OnapCommandUtils.class); + static Logger log = LoggerFactory.getLogger(OnapCommandUtils.class); /** * Private constructor. */ @@ -340,7 +340,7 @@ public class OnapCommandUtils { * @param to * @throws OnapCommandException */ - public static void copyParamSchemasFrom(OnapCommand from, OnapCommand to) throws OnapCommandException { + public static void copyParamSchemasFrom(OnapCommand from, OnapCommand to) { for (OnapCommandParameter param: from.getParameters()) { if (!to.getParametersMap().containsKey(param.getName())) { to.getParameters().add(param); diff --git a/main/src/main/java/org/onap/cli/main/OnapCli.java b/main/src/main/java/org/onap/cli/main/OnapCli.java index 43fa72ed..cf87c19a 100644 --- a/main/src/main/java/org/onap/cli/main/OnapCli.java +++ b/main/src/main/java/org/onap/cli/main/OnapCli.java @@ -56,7 +56,7 @@ import java.util.Optional; */ public class OnapCli { - private static Logger LOG = LoggerFactory.getLogger(OnapCli.class); + private static Logger log = LoggerFactory.getLogger(OnapCli.class); private List<String> args = new ArrayList<>(); @@ -87,7 +87,7 @@ public class OnapCli { private void print(Throwable throwable) { this.print(throwable.getMessage() != null ? throwable.getMessage() : ""); - LOG.error(throwable.getMessage(), throwable); + log.error(throwable.getMessage(), throwable); } private String getShortOption(String opt) { diff --git a/main/src/main/java/org/onap/cli/main/conf/OnapCliConstants.java b/main/src/main/java/org/onap/cli/main/conf/OnapCliConstants.java index 4389a8cc..edacc68b 100644 --- a/main/src/main/java/org/onap/cli/main/conf/OnapCliConstants.java +++ b/main/src/main/java/org/onap/cli/main/conf/OnapCliConstants.java @@ -1,5 +1,5 @@ /* - * Copyright 2017 Huawei Technologies Co., Ltd. + * Copyright 2017-18 Huawei Technologies Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -42,13 +42,13 @@ public final class OnapCliConstants { public static final String PARAM_INTERACTIVE_USE_MSG = "To set the current product version, more details please check version"; public static final String PARAM_INTERACTIVE_HELP = "help"; public static final String PARAM_INTERACTIVE_HELP_MSG = "To get the help details of supported commands"; - public static final String PARAM_INTERACTIVE_VERSION = "version"; + public static final String PARAM_INTERACTIVE_VERSION = PARAM_VERSION_LONG; public static final String PARAM_INTERACTIVE_VERSION_MSG = "To see the version details"; public static final String PARAM_INTERACTIVE_SET = "set"; public static final String PARAM_INTERACTIVE_SET_MSG = "To set the parameter values. Once its set, will be available for all commands in current session."; public static final String PARAM_INTERACTIVE_UNSET = "unset"; public static final String PARAM_INTERACTIVE_UNSET_MSG = "To unset the parameter value in current session."; - public static final String PARAM_INTERACTIVE_PROFILE = "profile"; + public static final String PARAM_INTERACTIVE_PROFILE = PARAM_PROFILE_LONG; public static final String PARAM_INTERACTIVE_PROFILE_MSG = "Start profiling current settings made of use, set."; public static final String PARAM_INTERACTIVE_ARG_SPLIT_PATTERN = "\\s+"; diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml new file mode 100644 index 00000000..def1e514 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-actionstatus +description: The ActionStatus command returns that state of any action request that has been previously submitted to an APPC instance for a specified VNF + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:action-status + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-attachhvolume-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-attachhvolume-schema.yaml new file mode 100644 index 00000000..d6d2502c --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-attachhvolume-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-attachvolume +description: Attach a cinder volume from a VM via an Openstack command + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:attach-volume + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-audit-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-audit-schema.yaml new file mode 100644 index 00000000..2ec23586 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-audit-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-audit +description: Audit VNF + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:audit + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-checklock-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-checklock-schema.yaml new file mode 100644 index 00000000..113ff67e --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-checklock-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-checklock +description: The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:check-lock + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configure-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configure-schema.yaml new file mode 100644 index 00000000..8cd19769 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configure-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-configure +description: Configure a VNF or a VNFC on the VNF after instantiation + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:configure + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurebackup-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurebackup-schema.yaml new file mode 100644 index 00000000..ff176c5e --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurebackup-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-configurebackup +description: Backup the current VNF configuration on a local file system - not in APPC. This is limited to Ansible and Chef. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:configure-backup + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configuremodify-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configuremodify-schema.yaml new file mode 100644 index 00000000..52c3ff1e --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configuremodify-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-configuremodify +description: Modifies the configuration on a VNF or VNFC in service. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:configure-modify + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurerestore-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurerestore-schema.yaml new file mode 100644 index 00000000..d67a8ef8 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurerestore-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-configurerestore +description: Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:configure-restore + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurescaleout-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurescaleout-schema.yaml new file mode 100644 index 00000000..6deaf5ab --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurescaleout-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-configurerescaleout +description: The ConfigScaleOut command is used to apply any actions on a VNF as part of a ScaleOut flow. Actions could include updating the VNF configuration or running a set of other tasks. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:configure-scale-out + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-detachvolume-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-detachvolume-schema.yaml new file mode 100644 index 00000000..da16f1a0 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-detachvolume-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-detachvolume +description: Detaches a cinder volume from a VM via an Openstack command + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:detach-volume + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-evacuate-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-evacuate-schema.yaml new file mode 100644 index 00000000..8b8f6cdb --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-evacuate-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-evacuate +description: Evacuates a specified VM from its current host to another + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:evacuate + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-healthcheck-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-healthcheck-schema.yaml new file mode 100644 index 00000000..cd0270ff --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-healthcheck-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-healthcheck +description: runs a VNF health check and returns the result + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:health-check + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 200 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-lock-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-lock-schema.yaml new file mode 100644 index 00000000..67479b97 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-lock-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-lock +description: Use the Lock command to ensure exclusive access during a series of critical LCM commands + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:lock + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-migrate-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-migrate-schema.yaml new file mode 100644 index 00000000..2e74b8d2 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-migrate-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-migrate +description: Migrates a running target VM from its current host to another. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:migrate + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-quiescetraffic-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-quiescetraffic-schema.yaml new file mode 100644 index 00000000..885ea6d9 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-quiescetraffic-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-quiescetraffic +description: The QuiesceTraffic LCM action gracefully stops the traffic on the VNF. All application processes are assumed to be running but no traffic is being processed. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:quiesce-traffic + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-rebuild-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-rebuild-schema.yaml new file mode 100644 index 00000000..519229fe --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-rebuild-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-rebuild +description: Rebuild VNF + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:rebuild + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-restart-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-restart-schema.yaml new file mode 100644 index 00000000..1a1a3f4d --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-restart-schema.yaml @@ -0,0 +1,163 @@ +open_cli_schema_version: 1.0 +name: vnf-restart +description: Restart VNF + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:restart + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-resumetraffic-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-resumetraffic-schema.yaml new file mode 100644 index 00000000..935c28f6 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-resumetraffic-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-resumetraffic +description: The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:resume-traffic + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-snapshot-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-snapshot-schema.yaml new file mode 100644 index 00000000..29951e13 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-snapshot-schema.yaml @@ -0,0 +1,160 @@ +open_cli_schema_version: 1.0 +name: vnf-snapshot +description: reates a snapshot of a VM + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: t + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: v + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: o + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: r + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: s + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags that apply to all LCM actions + type: string + short_option: r + long_option: flags-mode + is_optional: true + - name: flags-force + description: Generic flags that apply to all LCM actions + type: bool + short_option: f + long_option: flags-force + is_optional: true + - name: flags-ttl + description: Generic flags that apply to all LCM actions + type: digit + short_option: l + long_option: flags-ttl + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: a + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: i + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: j + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: n + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: k + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: q + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: p + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: timpestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: timpestamp + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:snapshot + method: POST + body: '{"input": {"common-header":{"timestamp": "${timestamp}","api-ver": "${api-version}","originator-id": "${orininator-id}","request-id": "$(request-id}","sub-request-id": "${sub-request-id}","flags":{"mode": "${flags-mode}","force": "${flags-force}","ttl": ${flags-ttl}"}}, "action": "${action}","action-identifiers": {"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}' diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-start-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-start-schema.yaml new file mode 100644 index 00000000..25c593eb --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-start-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-start +description: Start VNF + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:start + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-startapplication-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-startapplication-schema.yaml new file mode 100644 index 00000000..6d28ba79 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-startapplication-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-startapplication +description: Starts the VNF application, if needed, after a VM is instantiated/configured or after VM start or restart. Supported using Chef cookbook or Ansible playbook only + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:startapplication + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stop-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stop-schema.yaml new file mode 100644 index 00000000..e5b06458 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stop-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-stop +description: Stop VNF + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:stop + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stopapplication-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stopapplication-schema.yaml new file mode 100644 index 00000000..9d148428 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stopapplication-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-stopapplication +description: Stops the VNF application gracefully if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:stopapplication + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-sync-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-sync-schema.yaml new file mode 100644 index 00000000..58bdd352 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-sync-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-sync +description: The Sync action updates the current configuration in the APPC store with the running configuration from the device + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:sync + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-unlock-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-unlock-schema.yaml new file mode 100644 index 00000000..026da14c --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-unlock-schema.yaml @@ -0,0 +1,162 @@ +open_cli_schema_version: 1.0 +name: vnf-unlock +description: Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:unlock + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 100 + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackout-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackout-schema.yaml new file mode 100644 index 00000000..a1c03792 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackout-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-upgradebackout +description: The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed. This command is executed using an Ansible playbook or Chef cookbook. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:upgrade-backout + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}' body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status":{"code": "${status}","message": "<RESULT_MESSAGE>"}}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackup-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackup-schema.yaml new file mode 100644 index 00000000..067ae16b --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackup-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-upgradebackup +description: The UpgradeBackup LCM action does a full backup of the VNF data prior to an upgrade. The backup is done on the Ansible or Chef server in a location that is specified in the playbook or cookbook. If there is an existing backup, it is overwritten by the new backup. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:upgrade-backup + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradepostcheck-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradepostcheck-schema.yaml new file mode 100644 index 00000000..a8ebb93f --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradepostcheck-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-upgradepostcheck +description: The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:upgrade-post-check + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradeprecheck-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradeprecheck-schema.yaml new file mode 100644 index 00000000..e1b5b902 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradeprecheck-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-upgradeprecheck +description: The UpgradePreCheck LCM action checks that the VNF has the correct software version needed for a software upgrade. This command can be executed on a running VNF. + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:upgrade-pre-check + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradesoftware-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradesoftware-schema.yaml new file mode 100644 index 00000000..cb63c993 --- /dev/null +++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradesoftware-schema.yaml @@ -0,0 +1,161 @@ +open_cli_schema_version: 1.0 +name: vnf-upgradesoftware +description: The UpgradeSoftware LCM action upgrades the target VNF to a new version. It is expected that the VNF is in a quiesced status + +info: + product: onap-beijing + service: appc + author: ONAP CLI Team onap-discuss@lists.onap.org + state: experimental + +parameters: + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + type: string + short_option: T + long_option: timestamp + is_optional: false + - name: api-ver + description: Identifies the API version + type: string + short_option: X + long_option: api-ver + is_optional: false + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + type: string + short_option: O + long_option: originator-id + is_optional: false + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + type: string + short_option: R + long_option: request-id + is_optional: false + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters + type: string + short_option: W + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags-mode that apply to all LCM actions + type: string + short_option: F + is_optional: true + - name: flags-force + description: Generic flags-force that apply to all LCM actions + type: bool + short_option: G + is_optional: true + - name: flags-ttl + description: Generic flags-ttl that apply to all LCM actions + type: string + short_option: H + is_optional: true + - name: action + description: The action to be taken by APPC + type: string + short_option: A + long_option: action + is_optional: false + - name: service-instance-id + description: Identifies a specific service instance that the command refers to + type: string + short_option: S + long_option: service-instance-id + is_optional: true + - name: vnf-id + description: Identifies the VNF instance to which this action is to be applied + type: string + short_option: J + long_option: vnf-id + is_optional: true + is_optional: false + - name: vnfc-name + description: Identifies the VNFC name to which this action is to be applied + type: string + short_option: N + long_option: vnfc-name + is_optional: true + - name: vserver-id + description: Identifies a specific VM instance to which this action is to be applied + type: string + short_option: K + long_option: vserver-id + is_optional: true + - name: vf-module-id + description: Identifies a specific VF module to which this action is to be applied + type: string + short_option: M + long_option: vf-module-id + is_optional: true + - name: payload + description: An action-specific open-format field + type: string + short_option: P + long_option: payload + is_optional: true +results: + direction: portrait + attributes: + - name: action + description: The action to be taken by APPC + scope: short + type: string + - name: api-ver + description: Identifies the API version + scope: short + type: string + - name: flags + description: Identifies the API version + scope: short + type: string + - name: timestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: string + - name: status + description: The status describes the outcome of the command processing + scope: short + type: digit + - name: originator-id + description: An identifier of the calling system limited to a length of 40 characters + scope: short + type: string + - name: request-id + description: The UUID for the request ID, limited to a length of 40 characters + scope: short + type: string + - name: sub-request-id + description: Uniquely identifies a specific LCM or control action + scope: long + type: string + - name: payload + description: An open-format field + scope: long + type: string +http: + service: + auth: basic + mode: direct + request: + uri: /restconf/operations/vnf-provider-lcm:upgrade-software + method: POST + body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}' + success_codes: + - 400 + result_map: + action: $b{$.action} + api-ver: $b{$.api-ver} + flags: $b{$.flags} + originator-id: $b{$.originator-id} + request-id: $b{$.request-id} + sub-request-id: $b{$.sub-request-id} + payload: $b{$.payload} + status: $b{$.status} + timestamp: $b{$.timestamp} + + sample_response: + body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
\ No newline at end of file diff --git a/profiles/http/src/main/java/org/onap/cli/fw/http/auth/OnapCommandHttpAuthClient.java b/profiles/http/src/main/java/org/onap/cli/fw/http/auth/OnapCommandHttpAuthClient.java index fa4b9c2f..9b7b4039 100644 --- a/profiles/http/src/main/java/org/onap/cli/fw/http/auth/OnapCommandHttpAuthClient.java +++ b/profiles/http/src/main/java/org/onap/cli/fw/http/auth/OnapCommandHttpAuthClient.java @@ -22,7 +22,6 @@ import java.util.Map; import org.onap.cli.fw.cmd.OnapCommand; import org.onap.cli.fw.conf.OnapCommandConfig; import org.onap.cli.fw.error.OnapCommandException; -import org.onap.cli.fw.error.OnapCommandInvalidParameterValue; import org.onap.cli.fw.http.cmd.OnapHttpCommand; import org.onap.cli.fw.http.conf.OnapCommandHttpConstants; import org.onap.cli.fw.http.connect.HttpInput; diff --git a/profiles/http/src/main/java/org/onap/cli/fw/http/conf/OnapCommandHttpConstants.java b/profiles/http/src/main/java/org/onap/cli/fw/http/conf/OnapCommandHttpConstants.java index a4346a60..e6d5e031 100644 --- a/profiles/http/src/main/java/org/onap/cli/fw/http/conf/OnapCommandHttpConstants.java +++ b/profiles/http/src/main/java/org/onap/cli/fw/http/conf/OnapCommandHttpConstants.java @@ -53,12 +53,12 @@ public class OnapCommandHttpConstants { public static final String REQUEST = "request"; public static final String URI = "uri"; public static final String BODY = "body"; - public static final String METHOD_TYPE = "method"; + public static final String METHOD_TYPE = METHOD; public static final String POST = "post"; public static final String GET = "get"; public static final String DELETE = "delete"; public static final String PUT = "put"; - public static final String HEAD = "delete"; + public static final String HEAD = "head"; public static final String HEADERS = "headers"; public static final String QUERIES = "queries"; public static final String COOKIES = "cookies"; diff --git a/profiles/http/src/main/java/org/onap/cli/fw/http/connect/OnapHttpConnection.java b/profiles/http/src/main/java/org/onap/cli/fw/http/connect/OnapHttpConnection.java index 31786245..aee37236 100644 --- a/profiles/http/src/main/java/org/onap/cli/fw/http/connect/OnapHttpConnection.java +++ b/profiles/http/src/main/java/org/onap/cli/fw/http/connect/OnapHttpConnection.java @@ -64,7 +64,6 @@ import org.apache.http.impl.cookie.BasicClientCookie; import org.apache.http.protocol.BasicHttpContext; import org.apache.http.protocol.HttpContext; import org.apache.http.util.EntityUtils; -import org.onap.cli.fw.conf.OnapCommandConstants; import org.onap.cli.fw.http.conf.OnapCommandHttpConstants; import org.onap.cli.fw.http.error.OnapCommandHttpFailure; import org.slf4j.Logger; @@ -111,7 +110,7 @@ public class OnapHttpConnection { * @throws OnapCommandHttpFailure * exception */ - public OnapHttpConnection(boolean debug) throws OnapCommandHttpFailure { + public OnapHttpConnection(boolean debug) { this.debug = debug; } @@ -371,12 +370,13 @@ public class OnapHttpConnection { @NotThreadSafe static class HttpDeleteWithBody extends HttpEntityEnclosingRequestBase { + public HttpDeleteWithBody() { + super(); + } + public String getMethod() { return OnapCommandHttpConstants.DELETE; } - public HttpDeleteWithBody() { - super(); - } } } diff --git a/profiles/http/src/main/java/org/onap/cli/fw/http/mock/MocoServer.java b/profiles/http/src/main/java/org/onap/cli/fw/http/mock/MocoServer.java index f6e58757..f0fe43cd 100644 --- a/profiles/http/src/main/java/org/onap/cli/fw/http/mock/MocoServer.java +++ b/profiles/http/src/main/java/org/onap/cli/fw/http/mock/MocoServer.java @@ -15,30 +15,29 @@ */ package org.onap.cli.fw.http.mock; -import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.github.dreamhead.moco.HttpServer; -import com.github.dreamhead.moco.Moco; -import com.github.dreamhead.moco.ResponseHandler; -import com.github.dreamhead.moco.Runner; +import static com.github.dreamhead.moco.Runner.runner; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + import org.onap.cli.fw.conf.OnapCommandConfig; import org.onap.cli.fw.conf.OnapCommandConstants; import org.onap.cli.fw.error.OnapCommandDiscoveryFailed; import org.onap.cli.fw.error.OnapCommandException; -import org.onap.cli.fw.error.OnapCommandInvalidSchema; import org.onap.cli.fw.http.conf.OnapCommandHttpConstants; -import org.onap.cli.fw.schema.OnapCommandSchemaLoader; import org.onap.cli.fw.utils.OnapCommandDiscoveryUtils; import org.springframework.core.io.Resource; import org.yaml.snakeyaml.Yaml; -import java.io.IOException; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import static com.github.dreamhead.moco.Runner.runner; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.dreamhead.moco.HttpServer; +import com.github.dreamhead.moco.Moco; +import com.github.dreamhead.moco.ResponseHandler; +import com.github.dreamhead.moco.Runner; public class MocoServer { diff --git a/profiles/http/src/main/java/org/onap/cli/fw/http/schema/OnapCommandSchemaHttpLoader.java b/profiles/http/src/main/java/org/onap/cli/fw/http/schema/OnapCommandSchemaHttpLoader.java index 2cfb5206..5429b1af 100644 --- a/profiles/http/src/main/java/org/onap/cli/fw/http/schema/OnapCommandSchemaHttpLoader.java +++ b/profiles/http/src/main/java/org/onap/cli/fw/http/schema/OnapCommandSchemaHttpLoader.java @@ -47,6 +47,8 @@ import net.minidev.json.JSONObject; public class OnapCommandSchemaHttpLoader { + private static final String ATTRIBUTE = "Attribute '"; + private OnapCommandSchemaHttpLoader() { // to follow standards ! } @@ -174,15 +176,15 @@ public class OnapCommandSchemaHttpLoader { validationMap.put(OnapCommandHttpConstants.AUTH, OnapCommandHttpConstants.AUTH_VALUES); validationMap.put(OnapCommandHttpConstants.MODE, OnapCommandHttpConstants.MODE_VALUES); - for (String secKey : validationMap.keySet()) { - if (serviceMap.containsKey(secKey)) { - Object obj = serviceMap.get(secKey); + for (Map.Entry<String, String> secKey : validationMap.entrySet()) { + if (serviceMap.containsKey(secKey.getKey())) { + Object obj = serviceMap.get(secKey.getKey()); if (obj == null) { - errorList.add("Attribute '" + secKey + "' under '" + OnapCommandHttpConstants.SERVICE + "' is empty"); + errorList.add(ATTRIBUTE + secKey.getKey() + "' under '" + OnapCommandHttpConstants.SERVICE + "' is empty"); } else { String value = String.valueOf(obj); - if (!OnapCommandConfig.getCommaSeparatedList(validationMap.get(secKey)).contains(value)) { - errorList.add("Attribute '" + secKey + "' contains invalid value. Valide values are " + if (!OnapCommandConfig.getCommaSeparatedList(validationMap.get(secKey.getKey())).contains(value)) { + errorList.add(ATTRIBUTE + secKey.getKey() + "' contains invalid value. Valide values are " + OnapCommandConfig.getCommaSeparatedList(validationMap.get(key1))); // } } @@ -201,7 +203,7 @@ public class OnapCommandSchemaHttpLoader { break; case OnapCommandHttpConstants.VERSION: - srv.setVersion(serviceMap.get(key).toString()); + srv.setVersion(serviceMap.get(key)); break; case OnapCommandHttpConstants.AUTH: @@ -277,7 +279,7 @@ public class OnapCommandSchemaHttpLoader { return errorList; } - public static ArrayList<String> validateHttpSchemaSection(Map<String, ?> values) { + public static List<String> validateHttpSchemaSection(Map<String, ?> values) { ArrayList<String> errorList = new ArrayList<>(); Map<String, ?> map = (Map<String, ?>) values.get(OnapCommandHttpConstants.HTTP); Map<String, Object> requestMap = (Map<String, Object>) map.get(OnapCommandHttpConstants.REQUEST); @@ -288,7 +290,7 @@ public class OnapCommandSchemaHttpLoader { String method = (String) requestMap.get(OnapCommandHttpConstants.METHOD); if (method != null && !method.isEmpty()) { if (!OnapCommandConfig.getCommaSeparatedList(OnapCommandHttpConstants.HTTP_METHODS).contains(method.toLowerCase())) { - errorList.add("Attribute '" + OnapCommandHttpConstants.METHOD + "' under '" + OnapCommandHttpConstants.REQUEST + "' is invalid, correct types are " + errorList.add(ATTRIBUTE + OnapCommandHttpConstants.METHOD + "' under '" + OnapCommandHttpConstants.REQUEST + "' is invalid, correct types are " + OnapCommandConfig.getCommaSeparatedList(OnapCommandHttpConstants.HTTP_METHODS).toString()); } } else { diff --git a/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/cmd/OnapSnmpCommand.java b/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/cmd/OnapSnmpCommand.java index 1ee1b200..ed88b0c6 100644 --- a/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/cmd/OnapSnmpCommand.java +++ b/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/cmd/OnapSnmpCommand.java @@ -60,7 +60,7 @@ public class OnapSnmpCommand extends OnapCommand { super.addDefaultSchemas(OnapCommandSnmpConstants.DEFAULT_PARAMETER_SNMP_FILE_NAME); } - private String getAgent() throws OnapCommandException { + private String getAgent() { OnapCommandParameter onapCommandParameter = this.getParametersMap().get(OnapCommandSnmpConstants.SNMP_AGENT); return (String) onapCommandParameter.getValue(); } diff --git a/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/exception/OnapSnmpErrorResponse.java b/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/exception/OnapSnmpErrorResponse.java index 87b9241f..35d6425e 100644 --- a/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/exception/OnapSnmpErrorResponse.java +++ b/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/exception/OnapSnmpErrorResponse.java @@ -16,7 +16,6 @@ package org.onap.cli.fw.snmp.exception; -import org.onap.cli.fw.error.OnapCommandException; import org.onap.cli.fw.error.OnapCommandExecutionFailed; /** diff --git a/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/schema/OnapCommandSchemaSnmpLoader.java b/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/schema/OnapCommandSchemaSnmpLoader.java index 87cde127..c132be26 100644 --- a/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/schema/OnapCommandSchemaSnmpLoader.java +++ b/profiles/snmp/src/main/java/org/onap/cli/fw/snmp/schema/OnapCommandSchemaSnmpLoader.java @@ -16,19 +16,16 @@ package org.onap.cli.fw.snmp.schema; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + import org.onap.cli.fw.conf.OnapCommandConfig; -import org.onap.cli.fw.conf.OnapCommandConstants; import org.onap.cli.fw.error.OnapCommandException; -import org.onap.cli.fw.schema.OnapCommandSchemaLoader; import org.onap.cli.fw.snmp.cmd.OnapSnmpCommand; import org.onap.cli.fw.snmp.conf.OnapCommandSnmpConstants; import org.onap.cli.fw.utils.OnapCommandUtils; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - public class OnapCommandSchemaSnmpLoader { private static List<String> validateSnmpSchemaSection(Map<String, Object> values) { @@ -41,7 +38,7 @@ public class OnapCommandSchemaSnmpLoader { return errorList; } - public static ArrayList<String> parseSnmpSchema(OnapSnmpCommand cmd, + public static List<String> parseSnmpSchema(OnapSnmpCommand cmd, final Map<String, ?> values, boolean validate) throws OnapCommandException { diff --git a/profiles/snmp/src/test/resources/log4j.properties b/profiles/snmp/src/test/resources/log4j.properties new file mode 100644 index 00000000..78f32285 --- /dev/null +++ b/profiles/snmp/src/test/resources/log4j.properties @@ -0,0 +1,23 @@ +# Copyright 2018 Huawei Technologies Co., Ltd. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +log4j.rootLogger=ERROR, stdout + +log4j.logger.org.onap.cli=DEBUG, stdout + +# Direct log messages to stdout +log4j.appender.stdout=org.apache.log4j.ConsoleAppender +log4j.appender.stdout.Target=System.out +log4j.appender.stdout.layout=org.apache.log4j.PatternLayout +log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n |