products/onap-amsterdam/features/so/src/main/resources/open-cli-schema/services/vfmodule-create-schema-1.1.yaml

   1 # Copyright 2017-18 Huawei Technologies Co., Ltd.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 open_cli_schema_version: 1.0
  16 name: vfmodule-create
  17 description: Create a VF module
  18
  19 info:
  20   product: onap-amsterdam
  21   service: so
  22   author: ONAP CLI Team onap-discuss@lists.onap.org
  23
  24 parameters:
  25   - name: cloud-region
  26     description: cloud region identifier
  27     type: string
  28     short_option: l
  29     long_option: cloud-region
  30     is_optional: false
  31   - name: tenant-id
  32     description: openstack tenant id
  33     type: string
  34     short_option: B
  35     long_option: tenant-id
  36     is_optional: false
  37   - name: vfmodule-invariant-id
  38     description: vfmodule model invariant id
  39     type: string
  40     short_option: b
  41     long_option: vfmodule-invariant-id
  42     is_optional: false
  43   - name: vfmodule-uuid
  44     description: model uuid for vfmodule
  45     type: string
  46     short_option: c
  47     long_option: vfmodule-uuid
  48     is_optional: false
  49   - name: vfmodule-name
  50     description: vfmodule model name
  51     type: string
  52     short_option: e
  53     long_option: vfmodule-name
  54     is_optional: false
  55   - name: vfmodule-version
  56     description: vf module version
  57     type: string
  58     short_option: g
  59     long_option: vfmodule-version
  60     is_optional: false
  61   - name: module-name
  62     description: vfmodule name
  63     type: string
  64     short_option: i
  65     long_option: module-name
  66     is_optional: false
  67   - name: service-id
  68     description: unique id for service
  69     type: string
  70     short_option: j
  71     long_option: service-id
  72     is_optional: false
  73   - name: vf-id
  74     description: unique id for related VF
  75     type: string
  76     short_option: y
  77     long_option: vf-id
  78     is_optional: false
  79   - name: vf-model-invariant-id
  80     description: vf model invariant id
  81     type: string
  82     short_option: k
  83     long_option: vf-model-invariant-id
  84     is_optional: false
  85   - name: vf-model-uuid
  86     description: model uuid for vf
  87     type: string
  88     short_option: A
  89     long_option: vf-model-uuid
  90     is_optional: false
  91   - name: vf-model-name
  92     description: vf model name
  93     type: string
  94     short_option: n
  95     long_option: vf-model-name
  96     is_optional: false
  97   - name: vf-model-version
  98     description: vf model version
  99     type: string
 100     short_option: o
 101     long_option: vf-model-version
 102     is_optional: false
 103   - name: vf-model-customization-id
 104     description: vf model customization id. This can be obtained using SDC portal (Home -> service:xxx -> Composition -> click on VF for customization id).
 105     type: string
 106     short_option: q
 107     long_option: vf-model-customization-id
 108     is_optional: false
 109   - name: service-model-invariant-id
 110     description: model invariant id
 111     type: string
 112     short_option: r
 113     long_option: service-model-invariant-id
 114     is_optional: false
 115   - name: service-model-uuid
 116     description: model name version id
 117     type: string
 118     short_option: w
 119     long_option: service-model-uuid
 120     is_optional: false
 121   - name: service-model-name
 122     description: service model name
 123     type: string
 124     short_option: x
 125     long_option: service-model-name
 126     is_optional: false
 127   - name: service-model-version
 128     description: service model version
 129     type: string
 130     short_option: z
 131     long_option: service-model-version
 132     is_optional: false
 133
 134
 135 results:
 136   direction: portrait
 137   attributes:
 138     - name: vfmodule-id
 139       description: id for the created vnf
 140       type: string
 141       scope: short
 142
 143 http:
 144   service:
 145     name: so
 146     version: v3
 147     auth: basic
 148     mode: direct
 149   request:
 150     uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}/vnfs/${vf-id}/vfModules
 151     method: POST
 152     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": []}}}'
 153
 154   success_codes:
 155     - 202
 156   result_map:
 157     vfmodule-id: $b{$.requestReferences.instanceId}