gerrit.onap Code Review - cli.git/blob

   1 open_cli_schema_version: 1.0
   2 name: vfmodule-create
   3 description: Create a VF module
   4
   5 info:
   6   product: onap-amsterdam
   7   service: so
   8   author: ONAP CLI Team onap-discuss@lists.onap.org
   9
  10 parameters:
  11   - name: cloud-region
  12     description: cloud region identifier
  13     type: string
  14     short_option: l
  15     long_option: cloud-region
  16     is_optional: false
  17   - name: tenant-id
  18     description: openstack tenant id
  19     type: string
  20     short_option: B
  21     long_option: tenant-id
  22     is_optional: false
  23   - name: vfmodule-invariant-id
  24     description: vfmodule model invariant id
  25     type: string
  26     short_option: b
  27     long_option: vfmodule-invariant-id
  28     is_optional: false
  29   - name: vfmodule-uuid
  30     description: model uuid for vfmodule
  31     type: string
  32     short_option: c
  33     long_option: vfmodule-uuid
  34     is_optional: false
  35   - name: vfmodule-name
  36     description: vfmodule model name
  37     type: string
  38     short_option: e
  39     long_option: vfmodule-name
  40     is_optional: false
  41   - name: vfmodule-version
  42     description: vf module version
  43     type: string
  44     short_option: g
  45     long_option: vfmodule-version
  46     is_optional: false
  47   - name: module-name
  48     description: vfmodule name
  49     type: string
  50     short_option: i
  51     long_option: module-name
  52     is_optional: false
  53   - name: service-id
  54     description: unique id for service
  55     type: string
  56     short_option: j
  57     long_option: service-id
  58     is_optional: false
  59   - name: vf-id
  60     description: unique id for related VF
  61     type: string
  62     short_option: y
  63     long_option: vf-id
  64     is_optional: false
  65   - name: vf-model-invariant-id
  66     description: vf model invariant id
  67     type: string
  68     short_option: k
  69     long_option: vf-model-invariant-id
  70     is_optional: false
  71   - name: vf-model-uuid
  72     description: model uuid for vf
  73     type: string
  74     short_option: A
  75     long_option: vf-model-uuid
  76     is_optional: false
  77   - name: vf-model-name
  78     description: vf model name
  79     type: string
  80     short_option: n
  81     long_option: vf-model-name
  82     is_optional: false
  83   - name: vf-model-version
  84     description: vf model version
  85     type: string
  86     short_option: o
  87     long_option: vf-model-version
  88     is_optional: false
  89   - name: vf-model-customization-id
  90     description: vf model customization id. This can be obtained using SDC portal (Home -> service:xxx -> Composition -> click on VF for customization id).
  91     type: string
  92     short_option: q
  93     long_option: vf-model-customization-id
  94     is_optional: false
  95   - name: service-model-invariant-id
  96     description: model invariant id
  97     type: string
  98     short_option: r
  99     long_option: service-model-invariant-id
 100     is_optional: false
 101   - name: service-model-uuid
 102     description: model name version id
 103     type: string
 104     short_option: w
 105     long_option: service-model-uuid
 106     is_optional: false
 107   - name: service-model-name
 108     description: service model name
 109     type: string
 110     short_option: x
 111     long_option: service-model-name
 112     is_optional: false
 113   - name: service-model-version
 114     description: service model version
 115     type: string
 116     short_option: z
 117     long_option: service-model-version
 118     is_optional: false
 119
 120
 121 results:
 122   direction: portrait
 123   attributes:
 124     - name: vfmodule-id
 125       description: id for the created vnf
 126       type: string
 127       scope: short
 128
 129 http:
 130   service:
 131     name: so
 132     version: v3
 133     auth: basic
 134     mode: direct
 135   request:
 136     uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}/vnfs/${vf-id}/vfModules
 137     method: POST
 138     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": []}}}'
 139
 140   success_codes:
 141     - 202
 142   result_map:
 143     vfmodule-id: $b{$.requestReferences.instanceId}