diff options
Diffstat (limited to 'products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services')
7 files changed, 655 insertions, 0 deletions
diff --git a/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/service-create-schema-1.1.yaml b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/service-create-schema-1.1.yaml new file mode 100644 index 00000000..8073f07e --- /dev/null +++ b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/service-create-schema-1.1.yaml @@ -0,0 +1,97 @@ +open_cli_schema_version: 1.0 +name: service-create +description: Create a service instance using MSO + +info: + product: onap-amsterdam + service: so + author: ONAP CLI Team onap-discuss@lists.onap.org + +parameters: + - name: cloud-region + description: cloud region identifier + type: string + short_option: l + long_option: cloud-region + is_optional: false + - name: tenant-id + description: tenant id + type: string + short_option: b + long_option: tenant-id + is_optional: false + - name: model-invariant-id + description: model invariant id generated by ASDC. + type: string + short_option: e + long_option: model-invariant-id + is_optional: false + - name: model-uuid + description: model uuid generated by ASDC. + type: string + short_option: g + long_option: model-uuid + is_optional: false + - name: model-name + description: model name as provided in ASDC design time. + type: string + short_option: i + long_option: model-name + is_optional: false + - name: model-version + description: model-version + type: string + short_option: j + long_option: model-version + is_optional: false + - name: customer + description: unique id for customer + type: string + short_option: c + long_option: customer + is_optional: false + - name: instance-name + description: service instance name + type: string + short_option: k + long_option: instance-name + is_optional: false + - name: supress-rollback + description: rollback changes if instantiation fails. + type: bool + short_option: r + long_option: supress-rollback + is_optional: true + - name: service-type + description: subscription service type + type: string + short_option: w + long_option: service-type + is_optional: false + +results: + direction: portrait + attributes: + - name: service-id + description: instance id for the created service. + type: string + scope: short + + +http: + service: + name: so + version: v3 + auth: basic + mode: direct + request: + uri: /ecomp/mso/infra/serviceInstances/v3 + method: POST + body: '{"requestDetails": {"cloudConfiguration" : {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"modelInfo": {"modelType": "service","modelInvariantId": "${model-invariant-id}","modelNameVersionId": "${model-uuid}","modelName": "${model-name}","modelVersion": "${model-version}"},"subscriberInfo": {"globalSubscriberId": "${customer}"},"requestInfo": {"instanceName": "${instance-name}","source": "VID","suppressRollback": "${supress-rollback}"},"requestParameters": {"subscriptionServiceType": "${service-type}"}}}' + + success_codes: + - 202 + result_map: + service-id: $b{$.requestReferences.instanceId} + sample_response: + body: '{"requestReferences":{"instanceId":"${instance-id}","requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"}}' diff --git a/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/service-delete-schema-1.1.yaml b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/service-delete-schema-1.1.yaml new file mode 100644 index 00000000..ce45e2d8 --- /dev/null +++ b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/service-delete-schema-1.1.yaml @@ -0,0 +1,73 @@ +open_cli_schema_version: 1.0 +name: service-delete + +description: Delete service instance (experimental) + +info: + product: onap-amsterdam + service: so + author: ONAP CLI Team onap-discuss@lists.onap.org + +parameters: + - name: service-id + description: unique id for service instance + type: string + short_option: x + long_option: service-instace-id + is_optional: false + - name: model-invariant-id + description: model invariant id for service in SDC catalog + type: string + short_option: b + long_option: model-invariant-id + is_optional: false + - name: model-uuid + description: model uuid for service in SDC catalog + type: string + short_option: i + long_option: model-uuid + is_optional: false + - name: model-name + description: model name available in SDC catalog + type: string + short_option: e + long_option: model-name + is_optional: false + - name: model-version + description: model version of service (eg. 1.0) + type: string + short_option: g + long_option: model-version + is_optional: false + - name: customer-name + description: unique id for customer + type: string + short_option: c + long_option: customer-name + is_optional: false + - name: cloud-region + description: cloud region id + type: string + short_option: j + long_option: cloud-region + is_optional: false + - name: tenant-id + description: tenant id + type: string + short_option: k + long_option: tenant-id + is_optional: false + +http: + service: + name: so + version: v3 + auth: basic + mode: direct + request: + uri: /ecomp/mso/infra/serviceInstances/v3/${service-id} + method: DELETE + body: '{"requestDetails": {"modelInfo": {"modelType": "service","modelInvariantId": "${model-invariant-id}","modelVersionId": "${model-uuid}","modelName": "${model-name}","modelVersion": "${model-version}"},"cloudConfiguration" : {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"subscriberInfo": {"globalSubscriberId": "${customer-name}"},"requestInfo": {"source": "VID"}}}' + + success_codes: + - 202
\ No newline at end of file diff --git a/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-create-schema-1.1.yaml b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-create-schema-1.1.yaml new file mode 100644 index 00000000..9a56a9a4 --- /dev/null +++ b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-create-schema-1.1.yaml @@ -0,0 +1,121 @@ +open_cli_schema_version: 1.0 +name: vf-create +description: Create a VF +info: + product: onap-amsterdam + service: so + author: ONAP CLI Team onap-discuss@lists.onap.org + + +parameters: + - name: cloud-region + description: cloud region identifier + type: string + short_option: l + long_option: cloud-region + is_optional: false + - name: tenant-id + description: openstack tenant id + type: string + short_option: z + long_option: tenant-id + is_optional: false + - name: product-family + description: service type for serivce (e.g. vLB) + type: string + short_option: w + long_option: product-family + is_optional: false + - name: instance-name + description: service instance name + type: string + short_option: o + long_option: instance-name + is_optional: false + - name: service-instance-id + description: unique id for service instance + type: string + short_option: y + long_option: service-instance-id + is_optional: false + - name: vf-model-invariant-id + description: vf model invariant id + type: string + short_option: b + long_option: vf-model-invariant-id + is_optional: false + - name: vf-model-uuid + description: model uuid for vf + type: string + short_option: c + long_option: vf-model-uuid + is_optional: false + - name: vf-model-name + description: vf model name + type: string + short_option: e + long_option: vf-model-name + is_optional: false + - name: vf-model-version + description: vf model version + type: string + short_option: g + long_option: vf-model-version + is_optional: false + - name: vf-model-customization-id + description: vf model customization id + type: string + short_option: i + long_option: vf-model-customization-id + is_optional: false + - name: service-model-invariant-id + description: model invariant id + type: string + short_option: j + long_option: service-model-invariant-id + is_optional: false + - name: service-model-uuid + description: model name version id + type: string + short_option: k + long_option: service-model-uuid + is_optional: false + - name: service-model-name + description: service model name + type: string + short_option: q + long_option: service-model-name + is_optional: false + - name: service-model-version + description: service model version + type: string + short_option: n + long_option: service-model-version + is_optional: false + + +results: + direction: portrait + attributes: + - name: vf-id + description: id for the created vnf + type: string + scope: short + +http: + service: + name: so + version: v3 + auth: basic + mode: direct + request: + uri: /ecomp/mso/infra/serviceInstances/v3/${service-instance-id}/vnfs + method: POST + body: '{"requestDetails": {"modelInfo": {"modelType": "vnf","modelInvariantId": "${vf-model-invariant-id}","modelVersionId": "${vf-model-uuid}","modelName": "${vf-model-name}","modelVersion": "${vf-model-version}","modelCustomizationId": "${vf-model-customization-id}"},"cloudConfiguration": {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"requestInfo": {"instanceName": "${instance-name}","source": "VID","productFamilyId": "${product-family}" },"relatedInstanceList": [{"relatedInstance": {"instanceId": "${service-instance-id}","modelInfo": {"modelType": "service","modelInvariantId": "${service-model-invariant-id}","modelVersionId": "${service-model-uuid}","modelName": "${service-model-name}","modelVersion": "${service-model-version}"}}}],"requestParameters": {}}}' + + success_codes: + - 202 + result_map: + vf-id: $b{$.requestReferences.instanceId} + sample_response: + body: '{"requestReferences": {"instanceId": "2a152730-f6eb-4dc6-9b81-7a6f6f263d71","requestId": "6402628f-7f67-4605-9e60-0d8632616d02"}}' diff --git a/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-delete-schema-1.1.yaml b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-delete-schema-1.1.yaml new file mode 100644 index 00000000..e3a7cbea --- /dev/null +++ b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-delete-schema-1.1.yaml @@ -0,0 +1,70 @@ +open_cli_schema_version: 1.0 +name: vf-delete +description: delete a VF (experimental) +info: + product: onap-amsterdam + service: so + author: ONAP CLI Team onap-discuss@lists.onap.org + + +parameters: +- name: vf-id + description: id for vnf + type: string + short_option: x + long_option: vf-id + is_optional: false +- name: service-instance-id + description: unique id for service instance + type: string + short_option: y + long_option: service-instance-id + is_optional: false +- name: cloud-region + description: Cloud region ID + type: string + short_option: l + long_option: cloud-region + is_optional: false +- name: tenant-id + description: openstack tenant id (uuid) + type: string + short_option: z + long_option: tenant-id + is_optional: false +- name: model-invariant-id + description: model invariant id for service in SDC catalog + type: string + short_option: b + long_option: model-invariant-id + is_optional: false +- name: model-uuid + description: model uuid for service in SDC catalog + type: string + short_option: c + long_option: model-uuid + is_optional: false +- name: model-name + description: model name available in SDC catalog + type: string + short_option: e + long_option: model-name + is_optional: false +- name: model-version + description: model version of service (eg. 1.0) + type: string + short_option: g + long_option: model-version + is_optional: false +http: + service: + name: so + version: v3 + auth: basic + mode: direct + request: + uri: /ecomp/mso/infra/serviceInstances/v3/${service-instance-id}/vnfs/${vf-id} + method: DELETE + body: '{"requestDetails": {"modelInfo": {"modelType": "vnf","modelInvariantId":"${model-invariant-id}","modelVersionId": "${model-uuid}","modelName": "${model-name}","modelVersion":"${model-version}"},"cloudConfiguration": {"lcpCloudRegionId": "${cloud-region}","tenantId":"${tenant-id}"},"requestInfo": {"source": "VID"},"requestParameters": {"userParams":[]}}}' + success_codes: + - 202
\ No newline at end of file diff --git a/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-module-create-schema-1.1.yaml b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-module-create-schema-1.1.yaml new file mode 100644 index 00000000..3f08e44c --- /dev/null +++ b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-module-create-schema-1.1.yaml @@ -0,0 +1,78 @@ +open_cli_schema_version: 1.0 +name: vf-module-create +description: Create a VF Module + +info: + product: onap-amsterdam + service: so + author: ONAP CLI Team onap-discuss@lists.onap.org + +parameters: + - name: lcp-cloudregion-id + description: AIC LCP node location identifier + type: string + short_option: l + long_option: lcp-cloudregion-id + is_optional: false + - name: tenant-id + description: openstack tenant id (uuid) + type: string + short_option: w + long_option: tenant-id + is_optional: false + - name: vnf-instance-id + description: vnf instance id + type: string + short_option: y + long_option: vnf-instace-id + is_optional: false + - name: service-instance-id + description: unique id for service instance + type: string + short_option: x + long_option: service-instace-id + is_optional: false + - name: parenet-service-model + description: parent service model name + type: string + short_option: z + long_option: parenet-service-model + is_optional: false + - name: supress-rollback + description: rollback changes if instantiation fails. + type: bool + short_option: r + long_option: supress-rollback + is_optional: true + - name: instance-name + description: service instance name + type: string + short_option: i + long_option: instance-name + is_optional: false + +results: + direction: portrait + attribute: + - name: vf-instance-id + description: id for the created vf + type: string + scope: short + +http: + service: + name: so + version: v3 + auth: basic + mode: direct + request: + uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules + method: PUT + body: '{"requestDetails":{"modelInfo":{"modelType":"vfModule","modelInvariantId":"ff5256d2-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e5-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12..base..module-0","modelVersion":"1"},"cloudConfiguration":{"lcpCloudRegionId":"${lcp-cloudregion-id}","tenantId":"${tenant-id}"},"requestInfo":{"instanceName":"${instance-name}","source":"VID","suppressRollback":"${supress-rollback}"},"relatedInstanceList":[{"relatedInstance":{"instanceId":"${service-instance-id}","modelInfo":{"modelType":"service","modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe","modelName":"${parenet-service-model}","modelVersion":"1.0"}}},{"relatedInstance":{"instanceId":"${vnf-instance-id}","modelInfo":{"modelType":"vnf","modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12","modelVersion":"1.0","modelCustomizationName":"vSAMP12 1"}}}],"requestParameters":{"userParams":[]}}}' + + success_codes: + - 202 + result_mpa: + vf-instance-id: $b{$.vfInstanceId} + sample_response: + body: '{"vfInstanceId":"234567AB"}' diff --git a/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-module-delete-schema-1.1.yaml b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-module-delete-schema-1.1.yaml new file mode 100644 index 00000000..18ed5fc3 --- /dev/null +++ b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vf-module-delete-schema-1.1.yaml @@ -0,0 +1,73 @@ +open_cli_schema_version: 1.0 +name: vfmodule-delete + +description: delete a VF module (experimental) + +info: + product: onap-amsterdam + service: so + author: ONAP CLI Team onap-discuss@lists.onap.org + +parameters: + - name: vfmodule-id + description: VF module Id + type: string + short_option: x + long_option: vfmodule-id + is_optional: false + - name: service-id + description: unique id for service + type: string + short_option: j + long_option: service-id + is_optional: false + - name: vf-id + description: unique id for related VF + type: string + short_option: y + long_option: vf-id + is_optional: false + - name: vf-model-invariant-id + description: vf model invariant id + type: string + short_option: k + long_option: vf-model-invariant-id + is_optional: false + - name: vfmodule-name + description: vfmodule model name + type: string + short_option: e + long_option: vfmodule-name + is_optional: false + - name: vfmodule-version + description: vf module version + type: string + short_option: g + long_option: vfmodule-version + is_optional: false + - name: cloud-region + description: cloud region identifier + type: string + short_option: l + long_option: cloud-region + is_optional: false + - name: tenant-id + description: openstack tenant id + type: string + long_option: tenant-id + short_option: z + is_optional: false + +http: + service: + name: so + version: v3 + auth: basic + mode: direct + request: + uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}/vnfs/${vf-id}/vfModules/${vfmodule-id} + method: DELETE + body: '{"requestDetails":{"modelInfo":{"modelType":"vfModule","modelInvariantId":"${vf-model-invariant-id}","modelName":"${vfmodule-name}","modelVersion":"${vfmodule-version}"},"cloudConfiguration":{"lcpCloudRegionId":"${cloud-region}","tenantId":"${tenant-id}"},"requestInfo":{"source":"VID"}}}' + + success_codes: + - 202
\ No newline at end of file diff --git a/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vfmodule-create-schema-1.1.yaml b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vfmodule-create-schema-1.1.yaml new file mode 100644 index 00000000..e1f77aad --- /dev/null +++ b/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vfmodule-create-schema-1.1.yaml @@ -0,0 +1,143 @@ +open_cli_schema_version: 1.0 +name: vfmodule-create +description: Create a VF module + +info: + product: onap-amsterdam + service: so + author: ONAP CLI Team onap-discuss@lists.onap.org + +parameters: + - name: cloud-region + description: cloud region identifier + type: string + short_option: l + long_option: cloud-region + is_optional: false + - name: tenant-id + description: openstack tenant id + type: string + short_option: B + long_option: tenant-id + is_optional: false + - name: vfmodule-invariant-id + description: vfmodule model invariant id + type: string + short_option: b + long_option: vfmodule-invariant-id + is_optional: false + - name: vfmodule-uuid + description: model uuid for vfmodule + type: string + short_option: c + long_option: vfmodule-uuid + is_optional: false + - name: vfmodule-name + description: vfmodule model name + type: string + short_option: e + long_option: vfmodule-name + is_optional: false + - name: vfmodule-version + description: vf module version + type: string + short_option: g + long_option: vfmodule-version + is_optional: false + - name: module-name + description: vfmodule name + type: string + short_option: i + long_option: module-name + is_optional: false + - name: service-id + description: unique id for service + type: string + short_option: j + long_option: service-id + is_optional: false + - name: vf-id + description: unique id for related VF + type: string + short_option: y + long_option: vf-id + is_optional: false + - name: vf-model-invariant-id + description: vf model invariant id + type: string + short_option: k + long_option: vf-model-invariant-id + is_optional: false + - name: vf-model-uuid + description: model uuid for vf + type: string + short_option: A + long_option: vf-model-uuid + is_optional: false + - name: vf-model-name + description: vf model name + type: string + short_option: n + long_option: vf-model-name + is_optional: false + - name: vf-model-version + description: vf model version + type: string + short_option: o + long_option: vf-model-version + is_optional: false + - name: vf-model-customization-id + description: vf model customization id. This can be obtained using SDC portal (Home -> service:xxx -> Composition -> click on VF for customization id). + type: string + short_option: q + long_option: vf-model-customization-id + is_optional: false + - name: service-model-invariant-id + description: model invariant id + type: string + short_option: r + long_option: service-model-invariant-id + is_optional: false + - name: service-model-uuid + description: model name version id + type: string + short_option: w + long_option: service-model-uuid + is_optional: false + - name: service-model-name + description: service model name + type: string + short_option: x + long_option: service-model-name + is_optional: false + - name: service-model-version + description: service model version + type: string + short_option: z + long_option: service-model-version + is_optional: false + + +results: + direction: portrait + attributes: + - name: vfmodule-id + description: id for the created vnf + type: string + scope: short + +http: + service: + name: so + version: v3 + auth: basic + mode: direct + request: + uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}/vnfs/${vf-id}/vfModules + method: POST + body: '{"requestDetails": {"modelInfo": {"modelType": "vfModule","modelInvariantId": "${vfmodule-invariant-id}","modelNameVersionId": "${vfmodule-uuid}","modelName": "${vfmodule-name}","modelVersion": "${vfmodule-version}"},"cloudConfiguration": {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"requestInfo": {"instanceName": "${module-name}","source": "VID"},"relatedInstanceList": [{"relatedInstance": {"instanceId": "${service-id}","modelInfo": {"modelType": "service","modelInvariantId": "${service-model-invariant-id}","modelNameVersionId": "${service-model-uuid}","modelName": "${service-model-name}","modelVersion": "${service-model-version}"}}},{"relatedInstance": {"instanceId": "${vf-id}","modelInfo": {"modelType": "vnf","modelInvariantId": "${vf-model-invariant-id}","modelNameVersionId": "${vf-model-uuid}","modelName": "${vf-model-name}","modelVersion": "${vf-model-version}","modelCustomizationName": "${vf-model-customization-id}"}}}],"requestParameters": {"userParams": []}}}' + + success_codes: + - 202 + result_map: + vfmodule-id: $b{$.requestReferences.instanceId} |