description: ONAP basic login auth command
-version: onap-1.0
-
-type: auth
-
-service:
- name: onap
- version: v1
- mode: direct
+info:
+ product: onap-1.0
+ service: basic-auth
+ type: auth
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: portrait
description: ONAP basic login auth command
-version: onap-1.0
-type: auth
-
-service:
- name: onap
- version: v1
- mode: direct
+info:
+ product: onap-1.0
+ service: sdc-basic-auth
+ type: auth
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: portrait
description: ONAP basic logout auth command
-version: onap-1.0
-
-type: auth
-
-service:
- name: onap
- version: v1
- mode: direct
\ No newline at end of file
+info:
+ product: onap-1.0
+ service: basic-auth
+ type: auth
+ author: ONAP CLI Team onap-discuss@lists.onap.org
description: ONAP catalog command to find the base path for service.
-version: onap-1.0
-
-type: catalog
-
-service:
- name: msb
- version: v1
- mode: direct
- auth: none
+info:
+ product: onap-1.0
+ service: msb
+ type: catalog
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: catalog-service-name
short_option: i
long_option: catalog-service-version
is_optional: false
+
results:
direction: portrait
attributes:
scope: short
type: string
default_value: /
+
http:
+
+ service:
+ mode: direct
+ auth: none
request:
uri: /services/${catalog-service-name}/version/${catalog-service-version}
method: GET
open_cli_schema_version: 1.0
name: cloud-list
description: List the configured clouds and Onap service subscriptions
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
results:
direction: landscape
scope: long
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/cloud-infrastructure/cloud-regions
method: GET
open_cli_schema_version: 1.0
name: customer-create
description: Create a customer in Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: customer-name
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/business/customers/customer/${customer-name}
method: PUT
open_cli_schema_version: 1.0
name: customer-delete
description: Delete a customer from Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: customer-name
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/business/customers/customer/${customer-name}?resource-version=${resource-version}
method: DELETE
open_cli_schema_version: 1.0
name: customer-list
description: Lists the registetred customers in Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
results:
direction: landscape
attributes:
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/business/customers
method: GET
open_cli_schema_version: 1.0
name: customer-show
description: Lists the registetred customers in Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: customer-name
scope: long
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/business/customers/customer/${customer-name}
method: GET
open_cli_schema_version: 1.0
name: service-type-create
description: Add a service type in Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: service-type
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/service-design-and-creation/services/service/${service-type-id}
method: PUT
open_cli_schema_version: 1.0
name: service-type-delete
description: Delete a service type from Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: service-type-id
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/service-design-and-creation/services/service/${service-type-id}?resource-version=${resource-version}
queries:
open_cli_schema_version: 1.0
name: service-type-list
description: List the service types configured in Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
results:
direction: landscape
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/service-design-and-creation/services
method: GET
open_cli_schema_version: 1.0
name: subscription-create
description: Create a subscription for a customer in Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: customer-name
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/business/customers/customer/${customer-name}
method: PUT
open_cli_schema_version: 1.0
name: subscription-list
description: Lists the subscription for a given customer in Onap
-version: onap-1.0
-service:
- name: aai
- version: v8
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: customer-name
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v8/business/customers/customer/${customer-name}
method: GET
open_cli_schema_version: 1.0
name: license-model-create
description: Create License Model
-version: onap-1.0
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: vendor-name
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-license-models
method: POST
open_cli_schema_version: 1.0
name: license-model-show
description: Details of the License Model
-version: onap-1.0
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: license-model-id
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${license-model-id}
method: GET
open_cli_schema_version: 1.0
name: vsp-checkin
description: Checkin Vendor Software Product
-version: onap-1.0
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
long_option: vsp-id
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
method: PUT
open_cli_schema_version: 1.0
name: vsp-checkout
description: Checkout Vendor Software Product
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
long_option: vsp-id
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
method: PUT
open_cli_schema_version: 1.0
name: vsp-create
description: Create Vendor Software Product
-version: onap-1.0
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-name
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products
method: POST
open_cli_schema_version: 1.0
name: vsp-list
description: List of the Vendor Software Products
-version: onap-1.0
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: landscape
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products
method: GET
open_cli_schema_version: 1.0
name: vsp-show
description: Details of the Vendor Software Product
-version: onap-1.0
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}
method: GET
open_cli_schema_version: 1.0
name: vsp-submit
description: Submit Vendor Software Product
-version: onap-1.0
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
long_option: vsp-id
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
method: PUT
open_cli_schema_version: 1.0
name: vsp-upload
description: Upload the CSAR file to VSP
-version: onap-1.0
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.0
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
long_option: vsp-file
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/upload
method: POST
description: ONAP basic login auth command
-version: onap-1.1
-
-type: auth
-
-service:
- name: onap
- version: v1
- mode: direct
+info:
+ product: onap-1.1
+ service: basic-auth
+ type: auth
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: portrait
description: ONAP basic login auth command
-version: onap-1.1
-type: auth
+info:
+ product: onap-1.1
+ service: sdc-basic-auth
+ type: auth
+ author: ONAP CLI Team onap-discuss@lists.onap.org
-service:
- name: onap
- version: v1
- mode: direct
results:
direction: portrait
description: ONAP basic logout auth command
-version: onap-1.1
-
-type: auth
-
-service:
- name: onap
- version: v1
- mode: direct
\ No newline at end of file
+info:
+ product: onap-1.1
+ service: basic-auth
+ type: auth
+ author: ONAP CLI Team onap-discuss@lists.onap.org
description: ONAP catalog command to find the base path for service.
-version: onap-1.1
-type: catalog
+info:
+ product: onap-1.1
+ service: msb
+ type: catalog
+ author: ONAP CLI Team onap-discuss@lists.onap.org
-service:
- name: msb
- version: v1
- mode: direct
- auth: none
parameters:
- name: catalog-service-name
type: string
default_value: /
http:
+ service:
+ mode: direct
+ auth: none
request:
uri: /services/${catalog-service-name}/version/${catalog-service-version}
method: GET
open_cli_schema_version: 1.0
name: cloud-create
description: Create a cloud region in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: cloud-name
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}
method: PUT
open_cli_schema_version: 1.0
name: cloud-delete
description: Delete a cloud region from Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: cloud-name
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}?resource-version=${resource-version}
method: DELETE
open_cli_schema_version: 1.0
name: cloud-list
description: List the configured clouds and Onap service subscriptions
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: landscape
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions
method: GET
open_cli_schema_version: 1.0
name: customer-create
description: Create a customer in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: customer-name
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/business/customers/customer/${customer-name}
method: PUT
open_cli_schema_version: 1.0
name: customer-delete
description: Delete a customer from Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: customer-name
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/business/customers/customer/${customer-name}?resource-version=${resource-version}
method: DELETE
open_cli_schema_version: 1.0
name: customer-list
description: Lists the registetred customers in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
results:
direction: landscape
attributes:
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/business/customers
method: GET
open_cli_schema_version: 1.0
name: customer-show
description: Lists the registetred customers in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: customer-name
scope: long
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/business/customers/customer/${customer-name}
method: GET
description: Register a EMS in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: ems-id
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-ems-list/esr-ems/${ems-id}
method: PUT
description: Un-register a EMS in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: ems-id
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-ems-list/esr-ems/${ems-id}?resource-version=${resource-version}
method: DELETE
description: List the configured ems
-version: onap-1.1
-
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: landscape
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-ems-list
method: GET
description: Show the details of configured ems
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: ems-id
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-ems-list/esr-ems/${ems-id}/esr-system-info-list/esr-system-info/${ems-id}
method: GET
description: Register a SDNC in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: location
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/${sdnc-id}
method: PUT
description: Un-register a VNFM in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: sdnc-id
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/${sdnc-id}
method: DELETE
description: List the configured sdnc
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: landscape
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-sdnc-list
method: GET
open_cli_schema_version: 1.0
name: vim-register
description: Register a VIM under a given cloud region in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: cloud-name
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list/esr-system-info/${vim-id}
method: PUT
description: Un-register a VIM under from cloud region in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: cloud-name
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list/esr-system-info/${vim-id}?resource-version=${resource-version}
method: DELETE
description: List the configured vims
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: cloud-name
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list
method: GET
description: Register a VNFM in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vim-id
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-vnfm-list/esr-vnfm/${vnfm-id}
method: PUT
description: Un-register a VNFM in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vnfm-id
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-vnfm-list/esr-vnfm/${vnfm-id}?resource-version=${resource-version}
method: DELETE
description: List the configured vnfm
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: landscape
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-vnfm-list
method: GET
description: Show the VNFM in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vnfm-id
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/external-system/esr-vnfm-list/esr-vnfm/${vnfm-id}/esr-system-info-list/esr-system-info/${vnfm-id}
method: GET
open_cli_schema_version: 1.0
name: service-type-create
description: Add a service type in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: service-type
description: Onap service type
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/service-design-and-creation/services/service/${service-type-id}
method: PUT
open_cli_schema_version: 1.0
name: service-type-delete
description: Delete a service type from Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: service-type-id
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/service-design-and-creation/services/service/${service-type-id}?resource-version=${resource-version}
queries:
open_cli_schema_version: 1.0
name: service-type-list
description: List the service types configured in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: landscape
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/service-design-and-creation/services
method: GET
open_cli_schema_version: 1.0
name: subscription-create
description: Create a subscription of a customer for given service in specific cloud region in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: customer-name
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/business/customers/customer/${customer-name}/service-subscriptions/service-subscription/${service-type}
method: PUT
open_cli_schema_version: 1.0
name: subscription-delete
description: Delete the subscription for a given customer in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: customer-name
long_option: resource-version
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11//business/customers/customer/${customer-name}/service-subscriptions/service-subscription/${service-type}?resource-version=${resource-version}
method: DELETE
open_cli_schema_version: 1.0
name: subscription-list
description: Lists the subscription for a given customer in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: customer-name
scope: long
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/business/customers/customer/${customer-name}/service-subscriptions
method: GET
open_cli_schema_version: 1.0
name: tenant-create
description: Create a tenant under given cloud region in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: cloud
is_optional: false
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud}/${region}/tenants/tenant/${tenant-id}
method: PUT
open_cli_schema_version: 1.0
name: tenant-delete
description: Delete tenant under given cloud region in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: cloud
is_optional: true
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud}/${region}/tenants/tenant/${tenant-id}?resource-version=${resource-version}
method: DELETE
open_cli_schema_version: 1.0
name: tenant-list
description: Lists the tenants under given cloud region in Onap
-version: onap-1.1
-service:
- name: aai
- version: v11
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: aai
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: cloud
scope: short
type: string
http:
+ service:
+ auth: basic
+ mode: direct
request:
uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud}/${region}/tenants
method: GET
open_cli_schema_version: 1.0
name: microservice-create
description: Register microservice into Onap
-version: onap-1.1
-service:
- name: msb
- version: v1
- auth: none
+
+info:
+ product: onap-1.1
+ service: msb
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: service-name
scope: long
type: string
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /services
method: POST
open_cli_schema_version: 1.0
name: microservice-delete
description: Deletes the micro service from Onap
-version: onap-1.1
-service:
- name: msb
- version: v1
- auth: none
+
+info:
+ product: onap-1.1
+ service: msb
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: service-name
long_option: node-port
is_optional: false
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /services/${service-name}/version/${service-version}/nodes/${node-ip}/${node-port}
method: DELETE
open_cli_schema_version: 1.0
name: microservice-list
description: Lists the registetred micro services in Onap
-version: onap-1.1
-service:
- name: msb
- version: v1
- auth: none
+
+
+info:
+ product: onap-1.1
+ service: msb
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
results:
direction: landscape
attributes:
scope: long
type: string
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /services
method: GET
open_cli_schema_version: 1.0
name: microservice-show
description: Details the registered microservice in Onap
-version: onap-1.1
-service:
- name: msb
- version: v1
- auth: none
+
+info:
+ product: onap-1.1
+ service: msb
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
parameters:
- name: service-name
description: Onap service name
scope: long
type: string
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /services/${service-name}/version/${service-version}
method: GET
open_cli_schema_version: 1.0
name: license-model-create
description: Create License Model
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vendor-name
scope: short
type: string
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-license-models
method: POST
open_cli_schema_version: 1.0
name: license-model-show
description: Details of the License Model
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: license-model-id
scope: short
type: string
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${license-model-id}
method: GET
open_cli_schema_version: 1.0
name: vsp-checkin
description: Checkin Vendor Software Product
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
long_option: vsp-id
is_optional: false
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
method: PUT
open_cli_schema_version: 1.0
name: vsp-checkout
description: Checkout Vendor Software Product
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
long_option: vsp-id
is_optional: false
http:
+ service:
+ auth: none
+ mode: direct
+ service:
+ auth: none
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
method: PUT
open_cli_schema_version: 1.0
name: vsp-create
description: Create Vendor Software Product
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-name
scope: short
type: string
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products
method: POST
open_cli_schema_version: 1.0
name: vsp-list
description: List of the Vendor Software Products
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
results:
direction: landscape
scope: short
type: string
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products
method: GET
open_cli_schema_version: 1.0
name: vsp-show
description: Details of the Vendor Software Product
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
scope: short
type: string
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}
method: GET
open_cli_schema_version: 1.0
name: vsp-submit
description: Submit Vendor Software Product
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
long_option: vsp-id
is_optional: false
http:
+ service:
+ auth: none
+ mode: directs
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/actions
method: PUT
open_cli_schema_version: 1.0
name: vsp-upload
description: Upload the CSAR file to VSP
-version: onap-1.1
-service:
- name: sdc
- version: v1.0
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: sdc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vsp-id
long_option: vsp-file
is_optional: false
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /onboarding-api/v1.0/vendor-software-products/${vsp-id}/upload
method: POST
open_cli_schema_version: 1.0
name: service-create
description: Create a service instance using MSO
+<<<<<<< cf220435576757be81a477d68413c0dabc592478
version: onap-1.1
service:
name: so
version: v3
auth: basic
mode: direct
+=======
+
+info:
+ product: onap-1.1
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+>>>>>>> Migrate plugins to use info section
parameters:
- name: cloud-region
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /ecomp/mso/infra/serviceInstances/v3
method: POST
open_cli_schema_version: 1.0
name: service-delete
+<<<<<<< a936ccab2b00d462f0b1f3e8318004f0414f07ef
description: Delete service instance (experimental)
+=======
+<<<<<<< cf220435576757be81a477d68413c0dabc592478
+description: Delete service instance
+>>>>>>> Migrate plugins to use info section
version: onap-1.1
service:
name: so
version: v3
auth: basic
mode: direct
+=======
+description: Delete a service instance
+
+info:
+ product: onap-1.1
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+>>>>>>> Migrate plugins to use info section
parameters:
- name: service-id
is_optional: false
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}
method: DELETE
open_cli_schema_version: 1.0
name: vf-module-create
description: Create a VF Module
-version: onap-1.1
-service:
- name: mso
- version: v2
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: lcp-cloudregion-id
scope: short
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules
method: PUT
open_cli_schema_version: 1.0
name: vfmodule-delete
+<<<<<<< a936ccab2b00d462f0b1f3e8318004f0414f07ef
description: delete a VF module (experimental)
+=======
+description: delete a VF module
+<<<<<<< e22e4b6be3fe804a926136cf9ffd03341920ff50
+>>>>>>> Migrate plugins to use info section
version: onap-1.1
service:
name: so
version: v3
auth: basic
mode: direct
+=======
+
+info:
+ product: onap-1.1
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+>>>>>>> Migrate plugins to use info section
parameters:
- name: vfmodule-id
is_optional: false
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}/vnfs/${vf-id}/vfModules/${vfmodule-id}
method: DELETE
open_cli_schema_version: 1.0
name: vnf-create
description: Create a VNF
-version: onap-1.1
-service:
- name: mso
- version: v2
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: lcp-cloudregion-id
scope: short
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs
method: PUT
open_cli_schema_version: 1.0
name: vnf-delete
description: delete a VNF
-version: onap-1.1
-service:
- name: mso
- version: v2
- auth: basic
- mode: direct
+
+info:
+ product: onap-1.1
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: vnf-instance-id
is_optional: false
http:
+ service:
+ auth: none
+ mode: direct
request:
uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs
method: DELETE
description: First cmd hello world using http runing under lighttpd in cli at http://<cli-ip>:8080/version.json
info:
- product: sample
+ product: sample-1.0
service: hello-world
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: name
version: 1.0.0
auth: none
mode: direct
+
request:
uri: /version.json
method: GET
description: First cmd hello world
info:
- product: sample
+ product: sample-1.0
service: hello-world
-
-service:
- name: sample-service
- version: 1.0.0
- auth: none
- mode: direct
+ author: ONAP CLI Team onap-discuss@lists.onap.org
parameters:
- name: name