gerrit.onap Code Review - cli.git/blob

   1 # Copyright © Intel Corporation 2019\r
   2 #\r
   3 # Licensed under the Apache License, Version 2.0 (the "License");\r
   4 # you may not use this file except in compliance with the License.\r
   5 # You may obtain a copy of the License at\r
   6 #\r
   7 #     http://www.apache.org/licenses/LICENSE-2.0\r
   8 #\r
   9 # Unless required by applicable law or agreed to in writing, software\r
  10 # distributed under the License is distributed on an "AS IS" BASIS,\r
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  12 # See the License for the specific language governing permissions and\r
  13 # limitations under the License.\r
  14 \r
  15 open_cli_schema_version: 1.0\r
  16 name: vf-module-create\r
  17 description: Create a VF Module\r
  18 \r
  19 info:\r
  20   product: onap-elalto\r
  21   service: so\r
  22   author: ONAP CLI Team onap-discuss@lists.onap.org\r
  23 \r
  24 parameters:\r
  25   - name: lcp-cloudregion-id\r
  26     description: AIC LCP node location identifier\r
  27     type: string\r
  28     short_option: l\r
  29     long_option: lcp-cloudregion-id\r
  30     is_optional: false\r
  31   - name: cloud-owner\r
  32     description: cloud region cloud owner\r
  33     type: string\r
  34     short_option: co\r
  35     long_option: cloud-owner\r
  36     is_optional: false\r
  37   - name: tenant-id\r
  38     description: openstack tenant id (uuid)\r
  39     type: string\r
  40     short_option: w\r
  41     long_option: tenant-id\r
  42     is_optional: false\r
  43   - name: vnf-instance-id\r
  44     description: vnf instance id\r
  45     type: string\r
  46     short_option: y\r
  47     long_option: vnf-instance-id\r
  48     is_optional: false\r
  49   - name: service-instance-id\r
  50     description: unique id for service instance\r
  51     type: string\r
  52     short_option: x\r
  53     long_option: service-instace-id\r
  54     is_optional: false\r
  55   - name: parent-service-model\r
  56     description: parent service model name\r
  57     type: string\r
  58     short_option: z\r
  59     long_option: parent-service-model\r
  60     is_optional: false\r
  61   - name: service-model-id\r
  62     description: service model id\r
  63     type: string\r
  64     short_option: si\r
  65     long_option: service-model-id\r
  66     is_optional: false\r
  67   - name: service-model-invariant-id\r
  68     description: service model invariant id\r
  69     type: string\r
  70     short_option: sd\r
  71     long_option: service-model-invariant-id\r
  72     is_optional: false\r
  73   - name: service-model-version\r
  74     description: service model version\r
  75     type: string\r
  76     short_option: sv\r
  77     long_option: service-model-version\r
  78     is_optional: false\r
  79   - name: supress-rollback\r
  80     description: rollback changes if instantiation fails.\r
  81     type: bool\r
  82     short_option: r\r
  83     long_option: supress-rollback\r
  84     is_optional: false\r
  85   - name: instance-name\r
  86     description: service instance name\r
  87     type: string\r
  88     short_option: i\r
  89     long_option: instance-name\r
  90     is_optional: false\r
  91   - name: vf-module-model-invariant-id\r
  92     description: Invariant Id of vf module model in SO catalogdb\r
  93     type: string\r
  94     short_option: vi\r
  95     long_option: vf-module-model-invariant-id\r
  96     is_optional: false\r
  97   - name: vf-module-model-version-id\r
  98     description: version Id of vf module model in SO catalogdb\r
  99     type: string\r
 100     short_option: vv\r
 101     long_option: vf-module-model-version-id\r
 102     is_optional: false\r
 103   - name: vf-module-model-name\r
 104     description: Model Name of vf module model in SO catalogdb\r
 105     type: string\r
 106     short_option: vn\r
 107     long_option: vf-module-model-name\r
 108     is_optional: false\r
 109   - name: vf-module-model-customization-id\r
 110     description: Customization Id of vf module model in SO catalogdb\r
 111     type: string\r
 112     short_option: vc\r
 113     long_option: vf-module-model-customization-id\r
 114     is_optional: false\r
 115   - name: vf-module-model-version\r
 116     description: version of vf module model in SO catalogdb\r
 117     type: string\r
 118     short_option: vm\r
 119     long_option: vf-module-model-version\r
 120     is_optional: false\r
 121   - name: requestor-id\r
 122     description: Id of requestor\r
 123     type: string\r
 124     short_option: R\r
 125     long_option: requestor-id\r
 126     is_optional: false\r
 127   - name: vf-model-name\r
 128     description: name of vf model used in service model\r
 129     type: string\r
 130     short_option: vf\r
 131     long_option: vf-model-name\r
 132     is_optional: false\r
 133   - name: vf-model-invariant-id\r
 134     description: vf model invariant id\r
 135     type: string\r
 136     short_option: mi\r
 137     long_option: vf-model-invariant-id\r
 138     is_optional: false\r
 139   - name: vf-model-version\r
 140     description: vf model version\r
 141     type: string\r
 142     short_option: mv\r
 143     long_option: vf-model-version\r
 144     is_optional: false\r
 145   - name: vf-model-id\r
 146     description: vf model id\r
 147     type: string\r
 148     short_option: vid\r
 149     long_option: vf-model-id\r
 150     is_optional: false\r
 151   - name: vf-model-customization-id\r
 152     description: vf model customization id\r
 153     type: string\r
 154     short_option: mc\r
 155     long_option: vf-model-customization-id\r
 156     is_optional: false\r
 157   - name: vf-model-customization-name\r
 158     description: vf model customization name\r
 159     type: string\r
 160     short_option: mn\r
 161     long_option: vf-model-customization-name\r
 162     is_optional: false\r
 163   - name: test-api\r
 164     description: api for testing (VNF_API|GR_API)\r
 165     type: string\r
 166     short_option: api\r
 167     long_option: test-api\r
 168     is_optional: false\r
 169   - name: use-preload\r
 170     description: To use preloaded values or not\r
 171     type: bool\r
 172     short_option: up\r
 173     long_option: use-preload\r
 174     is_optional: false\r
 175 \r
 176 results:\r
 177   direction: portrait\r
 178   attribute:\r
 179     - name: vf-instance-id\r
 180       description: id for the created vf\r
 181       type: string\r
 182       scope: short\r
 183 \r
 184 http:\r
 185   service:\r
 186     name: so\r
 187     version: v6\r
 188     mode: direct\r
 189     auth: basic\r
 190   request:\r
 191     uri: /onap/so/infra/serviceInstantiation/v7/serviceInstances/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules\r
 192     method: POST\r
 193     body: '{\r
 194               "requestDetails":{\r
 195                  "modelInfo":{\r
 196                     "modelType":"vfModule",\r
 197                     "modelInvariantId":"${vf-module-model-invariant-id}",\r
 198                     "modelVersionId":"${vf-module-model-version-id}",\r
 199                     "modelName":"${vf-module-model-name}",\r
 200                     "modelVersion":"${vf-module-model-version}",\r
 201                     "modelCustomizationId": "${vf-module-model-customization-id}",\r
 202                     "modelCustomizationName": "${vf-module-model-name}"\r
 203                  },\r
 204                  "cloudConfiguration":{\r
 205                     "lcpCloudRegionId":"${lcp-cloudregion-id}",\r
 206                     "tenantId":"${tenant-id}",\r
 207                     "cloudOwner":"${cloud-owner}"\r
 208                  },\r
 209                  "requestInfo":{\r
 210                     "instanceName":"${instance-name}",\r
 211                     "source":"VID",\r
 212                     "suppressRollback":"${supress-rollback}",\r
 213                     "requestorId" : "${requestor-id}"\r
 214                  },\r
 215                  "relatedInstanceList":[\r
 216                     {\r
 217                        "relatedInstance":{\r
 218                           "instanceId":"${service-instance-id}",\r
 219                           "modelInfo":{\r
 220                              "modelType":"service",\r
 221                              "modelInvariantId":"${service-model-invariant-id}",\r
 222                              "modelVersionId":"${service-model-id}",\r
 223                              "modelName":"${parent-service-model}",\r
 224                              "modelVersion":"${service-model-version}"\r
 225                           }\r
 226                        }\r
 227                     },\r
 228                     {\r
 229                        "relatedInstance":{\r
 230                           "instanceId":"${vnf-instance-id}",\r
 231                           "modelInfo":{\r
 232                              "modelType":"vnf",\r
 233                              "modelInvariantId":"${vf-model-invariant-id}",\r
 234                              "modelVersionId":"${vf-model-id}",\r
 235                              "modelName":"${vf-model-name}",\r
 236                              "modelVersion":"${vf-model-version}",\r
 237                              "modelCustomizationId": "${vf-model-customization-id}",\r
 238                              "modelCustomizationName":"${vf-model-customization-name}"\r
 239                           }\r
 240                        }\r
 241                     }\r
 242                  ],\r
 243                  "requestParameters":{\r
 244                     "userParams":[],\r
 245                     "testApi": "${test-api}",\r
 246                     "usePreload": true\r
 247                  }\r
 248               }\r
 249            }'\r
 250 \r
 251   success_codes:\r
 252     - 202\r
 253   result_map:\r
 254     vf-instance-id: $b{$.vfInstanceId}\r
 255   sample_response:\r
 256     body: '{ "vfInstanceId" : "234567AB" }'\r