open_cli_schema_version: 1.0
name: vfmodule-create
description: Create a VF module
version: onap-1.1
service:
  name: mso
  version: v3
  auth: basic
  mode: direct

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: vfmodule-invariant-id
    description: vfmodule model invariant id
    type: string
    long_option: vfmodule-invariant-id
    is_optional: false
  - name: vfmodule-uuid
    description: model uuid for vfmodule
    type: string
    long_option: vfmodule-uuid
    is_optional: false
  - name: vfmodule-name
    description: vfmodule model name
    type: string
    long_option: vfmodule-name
    is_optional: false
  - name: vfmodule-version
    description: vf module version
    type: string
    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
    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
    long_option: vf-model-invariant-id
    is_optional: false
  - name: vf-model-uuid
    description: model uuid for vf
    type: string
    long_option: vf-model-uuid
    is_optional: false
  - name: vf-model-name
    description: vf model name
    type: string
    long_option: vf-model-name
    is_optional: false
  - name: vf-model-version
    description: vf model version
    type: string
    long_option: vf-model-version
    is_optional: false
  - name: vf-model-customization-id
    description: vf model customization id
    type: string
    long_option: vf-model-customization-id
    is_optional: false
  - name: service-model-invariant-id
    description: model invariant id
    type: string
    long_option: service-model-invariant-id
    is_optional: false
  - name: service-model-uuid
    description: model name version id
    type: string
    long_option: service-model-uuid
    is_optional: false
  - name: service-model-name
    description: service model name
    type: string
    long_option: service-model-name
    is_optional: false
  - name: service-model-version
    description: service model version
    type: string
    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:
  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}