aboutsummaryrefslogtreecommitdiffstats
path: root/products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vfmodule-create-schema-1.1.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vfmodule-create-schema-1.1.yaml')
-rw-r--r--products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vfmodule-create-schema-1.1.yaml143
1 files changed, 143 insertions, 0 deletions
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}