diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/platform/cli-userguide/VFC_part/index.rst | 18 | ||||
| -rw-r--r-- | docs/platform/cli-userguide/cloud_complex/index.rst | 40 | ||||
| -rw-r--r-- | docs/platform/cli-userguide/create_service_customer/index.rst | 71 | ||||
| -rw-r--r-- | docs/platform/cli-userguide/index.rst | 4 | ||||
| -rw-r--r-- | docs/platform/cli-userguide/register_all_clouds/index.rst | 39 | ||||
| -rw-r--r-- | docs/platform/cli-userguide/register_vnfm/index.rst | 38 | ||||
| -rw-r--r-- | docs/platform/index.rst | 3 |
7 files changed, 208 insertions, 5 deletions
diff --git a/docs/platform/cli-userguide/VFC_part/index.rst b/docs/platform/cli-userguide/VFC_part/index.rst index 322dbc2f..d92c4257 100644 --- a/docs/platform/cli-userguide/VFC_part/index.rst +++ b/docs/platform/cli-userguide/VFC_part/index.rst @@ -73,3 +73,21 @@ Cli VFC part Command Guide On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> For example: 'oclip vfc-nslcm-delete -m {} -c {}'.format(parameters["vfc-url"], ns_instance_id) + + +5. VFC nslcm get +---------------- + +:: + + usage: oclip vfc-nslcm-get + vfc nsclm get the status of creating ns + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-s | --long] + [-D | --context] [-c | --ns-instance-id] + Error: + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + For example: + 'oclip vfc-nslcm-delete -m {} -c {}'.format(parameters["vfc-url"], ns_instance_id) diff --git a/docs/platform/cli-userguide/cloud_complex/index.rst b/docs/platform/cli-userguide/cloud_complex/index.rst index 75c5a03c..efbbe2bd 100644 --- a/docs/platform/cli-userguide/cloud_complex/index.rst +++ b/docs/platform/cli-userguide/cloud_complex/index.rst @@ -30,4 +30,42 @@ Cli cloud complex Command Guide parameters["lata"], parameters["city"], parameters["postal-code"], \ parameters["complex_name"], parameters["country"], parameters["elevation"], \ parameters["identity_url"], parameters["aai_url"], parameters["aai_username"], \ - parameters["aai_password"])
\ No newline at end of file + parameters["aai_password"]) + +2. complex-list +----------------- + +:: + + + usage: oclip complex-list + List the configured complexes + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] + For example: + "oclip complex-list -m {} -u {} -p {}".format(parameters["aai_url"], parameters["aai_username"], \ + parameters["aai_password"]) + + +3. complex-delete +----------------- + +:: + + + usage: oclip complex-delete + Delete a complex from Onap + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-y | --resource-version] + [-s | --long] [-D | --context] [-x | --complex-name] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] + For example: + oclip complex-delete -m https://159.138.61.203:30233 -u AAI -p AAI -x clli1 -y 1568444028429 + Note: + complex-name and resource-version is the result returned after executing the complex-list command(command 2) diff --git a/docs/platform/cli-userguide/create_service_customer/index.rst b/docs/platform/cli-userguide/create_service_customer/index.rst index 55489931..042239ec 100644 --- a/docs/platform/cli-userguide/create_service_customer/index.rst +++ b/docs/platform/cli-userguide/create_service_customer/index.rst @@ -81,3 +81,74 @@ Cli Create Service and Customer Command Guide "oclip subscription-cloud-add -x {} -c {} -z {} -e {} -y {} -r {} -m {} -u {} -p {}".format(\ parameters["customer_name"], cloud_region_values.get("tenant-id"), parameters["cloud-owner"], parameters["service_name"],\ cloud_region_values.get("default-tenant"), cloud_region, parameters["aai_url"], parameters["aai_username"], parameters["aai_password"] ) + +5. service type list +-------------------- + +:: + + usage: oclip service-type-list + List the service types configured in Onap + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] + For example: + "oclip service-type-list -m {} -u {} -p {}".format(parameters["aai_url"], parameters["aai_username"], \ + parameters["aai_password"]) + +6. service type delete +---------------------- + +:: + + usage: oclip service-type-delete + usage: oclip service-type-delete + Delete a service type from Onap + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-y | --resource-version] + [-x | --service-type-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] + For example: + oclip service-type-delete -m https://159.138.61.203:30233 -u AAI -p AAI -x baf23ae9-f890-4b92-b568-2a70f5c86993 -y 1568444204387 + Note: + service-type-id and resource-version is the result returned after executing the service-type-list command(command 5) + +7. customer list +---------------- + +:: + + usage: oclip customer-list + Lists the registered customers in Onap + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] + For example: + oclip customer-list -m {} -u {} -p {}".format(parameters["aai_url"], parameters["aai_username"], \ + parameters["aai_password"]) + +8. customer delete +------------------ + +:: + + usage: oclip customer-delete + Delete a customer from Onap + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-y | --resource-version] + [-s | --long] [-D | --context] [-x | --customer-id] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] + For example: + oclip customer-delete -m https://159.138.61.203:30233 -u AAI -p AAI -x customer2 -y 1568615567019 + Note: + customer-id and resource-version is the result returned after executing the customer-list command(command 7) diff --git a/docs/platform/cli-userguide/index.rst b/docs/platform/cli-userguide/index.rst index 38b7204c..d89e2118 100644 --- a/docs/platform/cli-userguide/index.rst +++ b/docs/platform/cli-userguide/index.rst @@ -13,8 +13,8 @@ Reference manual: Note: -The config. JSON included in the folder is a data guarantee for the example in the guidance manual, which will be converted into Python recognizable object body through the json. load method. Use "parameters" to receive the converted results. (parameters = json. load (config)) - +1. The config. JSON included in the folder is a data guarantee for the example in the guidance manual, which will be converted into Python recognizable object body through the json. load method. Use "parameters" to receive the converted results. (parameters = json. load (config)) +2. You should go to the pod of the CLI environment in the corresponding test environment to execute the command action steps .. contents:: :depth: 2 diff --git a/docs/platform/cli-userguide/register_all_clouds/index.rst b/docs/platform/cli-userguide/register_all_clouds/index.rst index 34f978bf..651f8a05 100644 --- a/docs/platform/cli-userguide/register_all_clouds/index.rst +++ b/docs/platform/cli-userguide/register_all_clouds/index.rst @@ -30,4 +30,41 @@ Cli Regist Clouds Command Guide values.get("service-url"), parameters["complex_name"], values.get("cloud-type"), parameters["owner-defined-type"], \ values.get("system-type"), values.get("identity-url"), parameters["cloud-zone"], values.get("ssl-insecure"), \ values.get("system-status"), values.get("cloud-domain"), parameters["aai_url"], parameters["aai_username"], \ - parameters["aai_password"])
\ No newline at end of file + parameters["aai_password"]) + + +2. cloud list +-------------- + +:: + + usage: oclip cloud-list + List the configured clouds and Onap service subscriptions + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] + For example: + "oclip cloud-list -m {} -u {} -p {}".format(parameters["aai_url"], parameters["aai_username"], \ + parameters["aai_password"]) + +3. cloud delete +--------------- + +:: + + usage: oclip cloud-delete + Delete a cloud region from Onap + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-x | --cloud-name] + [-z | --resource-version] [-s | --long] [-D | --context] + [-y | --region-name] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] + For example: + oclip cloud-delete -m https://159.138.61.203:30233 -u AAI -p AAI -y admin-fd -z 1568466594680 -x CloudOwner + Note: + region-name and resource-version and cloud-name is the result returned after executing the cloud-list command(command 2) diff --git a/docs/platform/cli-userguide/register_vnfm/index.rst b/docs/platform/cli-userguide/register_vnfm/index.rst index f91cdaeb..78aaaaee 100644 --- a/docs/platform/cli-userguide/register_vnfm/index.rst +++ b/docs/platform/cli-userguide/register_vnfm/index.rst @@ -25,3 +25,41 @@ Cli Regist Vnfm Command Guide values.get("version"), values.get("url"), values.get("vim-id"), \ values.get("user-name"), values.get("user-password"), values.get("vnfm-version"), \ parameters["aai_url"], parameters["aai_username"], parameters["aai_password"]) + +2. vnfm list +--------------- + +:: + + usage: oclip vnfm-list + List the configured vnfm + Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] + For example: + "oclip vnfm-list -m {} -u {} -p {}".format(parameters["aai_url"], parameters["aai_username"], \ + parameters["aai_password"]) + + +3. vnfm-delete +----------------- + +:: + + + usage: oclip vnfm-delete + Un-register a VNFM in Onap + Options: + [-m | --host-url] [-C | --no-catalog] [-f | --format] + [-h | --help] [-V | --verify] [-t | --no-title] + [-d | --debug] [-v | --version] [-y | --resource-version] + [-x | --vnfm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] + For example: + oclip vnfm-delete -m https://159.138.61.203:30233 -uAAI -p AAI -x 4839a0bc-60d1-4346-9c69-185d0962633b -y 1568450136276 + Note: + vnfm-id and resource-version is the result returned after executing the vnfm-list command(command 2) diff --git a/docs/platform/index.rst b/docs/platform/index.rst index d9f6feea..9eb80b1c 100644 --- a/docs/platform/index.rst +++ b/docs/platform/index.rst @@ -53,5 +53,6 @@ VF-C as one controller in ONAP includes two components NFV-O and GVNFM. consumedapis.rst delivery.rst logging.rst - installation/index + installation/inde + cli-userguide/index administration.rst |