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