7dc5c372f28f4f9b7b081632128f7019ba93e198
[cli.git] /
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-dublin\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: tenant-id\r
32     description: openstack tenant id (uuid)\r
33     type: string\r
34     short_option: w\r
35     long_option: tenant-id\r
36     is_optional: false\r
37   - name: vnf-instance-id\r
38     description: vnf instance id\r
39     type: string\r
40     short_option: y\r
41     long_option: vnf-instace-id\r
42     is_optional: false\r
43   - name: service-instance-id\r
44     description: unique id for service instance\r
45     type: string\r
46     short_option: x\r
47     long_option: service-instace-id\r
48     is_optional: false\r
49   - name: parenet-service-model\r
50     description: parent service model name\r
51     type: string\r
52     short_option: z\r
53     long_option: parenet-service-model\r
54     is_optional: false\r
55   - name: supress-rollback\r
56     description: rollback changes if instantiation fails.\r
57     type: bool\r
58     short_option: r\r
59     long_option: supress-rollback\r
60     is_optional: true\r
61   - name: instance-name\r
62     description: service instance name\r
63     type: string\r
64     short_option: i\r
65     long_option: instance-name\r
66     is_optional: false\r
67 \r
68 results:\r
69   direction: portrait\r
70   attribute:\r
71     - name: vf-instance-id\r
72       description: id for the created vf\r
73       type: string\r
74       scope: short\r
75 \r
76 http:\r
77   service:\r
78     name: so\r
79     version: v6\r
80     auth: basic\r
81     mode: direct\r
82   request:\r
83     uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules\r
84     method: POST\r
85     body: '{\r
86               "requestDetails":{\r
87                  "modelInfo":{\r
88                     "modelType":"vfModule",\r
89                     "modelInvariantId":"ff5256d2-5a33-55df-13ab-12abad84e7ff",\r
90                     "modelNameVersionId":"fe6478e5-ea33-3346-ac12-ab121484a3fe",\r
91                     "modelName":"vSAMP12..base..module-0",\r
92                     "modelVersion":"1"\r
93                  },\r
94                  "cloudConfiguration":{\r
95                     "lcpCloudRegionId":"${lcp-cloudregion-id}",\r
96                     "tenantId":"${tenant-id}"\r
97                  },\r
98                  "requestInfo":{\r
99                     "instanceName":"${instance-name}",\r
100                     "source":"VID",\r
101                     "suppressRollback":"${supress-rollback}"\r
102                  },\r
103                  "relatedInstanceList":[\r
104                     {\r
105                        "relatedInstance":{\r
106                           "instanceId":"${service-instance-id}",\r
107                           "modelInfo":{\r
108                              "modelType":"service",\r
109                              "modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff",\r
110                              "modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe",\r
111                              "modelName":"${parenet-service-model}",\r
112                              "modelVersion":"1.0"\r
113                           }\r
114                        }\r
115                     },\r
116                     {\r
117                        "relatedInstance":{\r
118                           "instanceId":"${vnf-instance-id}",\r
119                           "modelInfo":{\r
120                              "modelType":"vnf",\r
121                              "modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff",\r
122                              "modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe",\r
123                              "modelName":"vSAMP12",\r
124                              "modelVersion":"1.0",\r
125                              "modelCustomizationName":"vSAMP12 1"\r
126                           }\r
127                        }\r
128                     }\r
129                  ],\r
130                  "requestParameters":{\r
131                     "userParams":[\r
132 \r
133                     ]\r
134                  }\r
135               }\r
136            }'\r
137 \r
138   success_codes:\r
139     - 202\r
140   result_mpa:\r
141     vf-instance-id: $b{$.vfInstanceId}\r
142   sample_response:\r
143     body: '{ "vfInstanceId" : "234567AB" }'\r