4 title: SOL003 - VNF Lifecycle Management interface
6 SOL003 - VNF Lifecycle Management interface
9 email: OSM_TECH@list.etsi.org
12 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
16 description: Operations related to VNF instances
19 - url: http://127.0.0.1/vnflcm/v1
20 - url: https://127.0.0.1/vnflcm/v1
25 - $ref: ../components/SOL003_params.yaml#/components/parameters/Accept
26 - $ref: ../components/SOL003_params.yaml#/components/parameters/Authorization
27 - $ref: ../components/SOL003_params.yaml#/components/parameters/Version
31 summary: Query information about multiple VNF instances
32 description: The GET method queries information about multiple VNF instances.
35 $ref: '#/components/responses/VNFInstances.Get.200'
37 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
39 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
41 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
43 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
45 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
47 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
49 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
51 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
53 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
55 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
57 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
59 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
63 summary: Create a new VNF instance resource
65 The POST method creates a new VNF instance resource based on a VNF package that is onboarded
66 and in "ENABLED" state.
68 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest'
71 $ref: '#/components/responses/VNFInstances.Post.201'
73 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
75 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
77 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
79 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
81 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
83 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
85 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
87 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
89 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
91 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
93 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
95 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
97 /vnf_instances/{vnfInstanceId}:
99 - $ref: '#/components/parameters/VnfInstanceId'
100 - $ref: ../components/SOL003_params.yaml#/components/parameters/Authorization
101 - $ref: ../components/SOL003_params.yaml#/components/parameters/Version
105 summary: Read an individual VNF instance resource
107 The GET method retrieves information about a VNF instance by reading an "Individual VNF instance" resource.
110 $ref: '#/components/responses/IndividualVnfInstance.Get.200'
112 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
114 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
116 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
118 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
120 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
122 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
124 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
126 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
128 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
130 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
132 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
134 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
138 summary: Delete an individual VNF instance resource
139 description: This method deletes an "Individual VNF instance" resource.
142 description: No Content
144 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
146 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
148 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
150 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
152 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
154 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
156 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
158 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
160 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
162 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
164 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
166 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
168 /vnf_instances/{vnfInstanceId}/instantiate:
170 - $ref: '#/components/parameters/VnfInstanceId'
174 summary: Instantiate a VNF
176 The POST method instantiates a VNF instance. The precondition is that the VNF instance
177 must have been created and must be in NOT_INSTANTIATED state.
179 - $ref: ../components/SOL003_params.yaml#/components/parameters/Accept
180 - $ref: ../components/SOL003_params.yaml#/components/parameters/Authorization
181 - $ref: ../components/SOL003_params.yaml#/components/parameters/Version
183 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest'
186 $ref: '#/components/responses/InstantiateVnfInstance.Post.202'
188 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
190 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
192 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
194 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
196 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
198 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
200 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
202 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
204 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
206 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
208 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
210 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
212 /vnf_instances/{vnfInstanceId}/scale:
214 - $ref: '#/components/parameters/VnfInstanceId'
218 summary: Scale a VNF instance
220 The POST method requests to scale a VNF instance resource. The precondition is that the VNF instance
221 must have been created and must be in INSTANTIATED state.
223 - $ref: ../components/SOL003_params.yaml#/components/parameters/Accept
224 - $ref: ../components/SOL003_params.yaml#/components/parameters/Authorization
225 - $ref: ../components/SOL003_params.yaml#/components/parameters/Version
227 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest'
230 $ref: '#/components/responses/ScaleVnfInstance.Post.202'
232 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
234 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
236 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
238 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
240 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
242 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
244 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
246 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
248 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
250 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
252 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
254 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
256 /vnf_instances/{vnfInstanceId}/terminate:
258 - $ref: '#/components/parameters/VnfInstanceId'
262 summary: Terminate a VNF instance
264 The POST method requests to terminate a VNF instance. The precondition is that the VNF
265 instance must have been created and must be in INSTANTIATED state.
267 - $ref: ../components/SOL003_params.yaml#/components/parameters/Accept
268 - $ref: ../components/SOL003_params.yaml#/components/parameters/Authorization
269 - $ref: ../components/SOL003_params.yaml#/components/parameters/Version
271 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest'
274 $ref: '#/components/responses/TerminateVnfInstance.Post.202'
276 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
278 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
280 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
282 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
284 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
286 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
288 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
290 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
292 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
294 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
296 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
298 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
304 summary: Query information about multiple VNF LCM Operation Occurrences
305 description: Query information about multiple VNF LCM Operation Occurrences
308 $ref: '#/components/responses/VnfLcmOpOccs.Get.200'
310 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
312 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
314 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
316 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
318 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
320 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
322 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
324 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
326 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
328 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
330 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
332 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
334 /vnf_lcm_op_occs/{vnfLcmOpOccId}:
336 - $ref: '#/components/parameters/VnfLcmOpOccId'
340 summary: Query information about an individual VNF LCM Operation Occurrence
341 description: Query information about an individual VNF LCM Operation Occurrence
344 $ref: '#/components/responses/IndividualVnfLcmOpOcc.Get.200'
346 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
348 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
350 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
352 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
354 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
356 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
358 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
360 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
362 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
364 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
366 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
368 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
371 ###############################################################################
373 ###############################################################################
378 summary: Query information about multiple VNF instance subscription
379 description: Query information about multiple VNF instance subscription
382 $ref: '#/components/responses/Subscriptions.Get.200'
384 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
386 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
388 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
390 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
392 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
394 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
396 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
398 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
400 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
402 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
404 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
406 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
410 summary: Creates a new subscription
411 description: The POST method creates a new subscription.
413 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest'
416 $ref: '#/components/responses/Subscriptions.Post.201'
418 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
420 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
422 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
424 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
426 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
428 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
430 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
432 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
434 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
436 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
438 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
440 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
442 /subscriptions/{subscriptionId}:
444 - $ref: '#/components/parameters/SubscriptionId'
445 - $ref: ../components/SOL003_params.yaml#/components/parameters/Authorization
446 - $ref: ../components/SOL003_params.yaml#/components/parameters/Version
450 summary: Read information about individual subscription resource
452 The GET method retrieves information about a subscription by reading an "Individual subscription" resource.
455 $ref: '#/components/responses/IndividualSubscription.Get.200'
457 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
459 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
461 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
463 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
465 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
467 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
469 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
471 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
473 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
475 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
477 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
479 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
483 summary: Delete an individual subscription resource
484 description: The DELETE method terminates an individual subscription.
487 description: No Content
489 $ref: '../responses/SOL003_resp.yaml#/components/responses/400'
491 $ref: '../responses/SOL003_resp.yaml#/components/responses/401'
493 $ref: '../responses/SOL003_resp.yaml#/components/responses/403'
495 $ref: '../responses/SOL003_resp.yaml#/components/responses/404'
497 $ref: '../responses/SOL003_resp.yaml#/components/responses/405'
499 $ref: '../responses/SOL003_resp.yaml#/components/responses/406'
501 $ref: '../responses/SOL003_resp.yaml#/components/responses/409'
503 $ref: '../responses/SOL003_resp.yaml#/components/responses/422'
505 $ref: '../responses/SOL003_resp.yaml#/components/responses/500'
507 $ref: '../responses/SOL003_resp.yaml#/components/responses/503'
509 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
511 $ref: '../responses/SOL003_resp.yaml#/components/responses/UnexpectedError'
519 description: Identifier of the VNF instance
527 Identifier of the VNF lifecycle management operation occurrence
534 description: Identifier of the VNF subscription occurrence
539 VNFInstances.Get.200:
544 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ArrayOfVnfInstance'
547 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ArrayOfVnfInstance'
548 VNFInstances.Post.201:
558 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ObjectId'
561 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ObjectId'
562 IndividualVnfInstance.Get.200:
567 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance'
570 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance'
571 InstantiateVnfInstance.Post.202:
572 description: Accepted
581 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ObjectId'
584 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ObjectId'
585 ScaleVnfInstance.Post.202:
586 description: Accepted
595 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ObjectId'
598 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ObjectId'
599 TerminateVnfInstance.Post.202:
600 description: Accepted
609 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ObjectId'
612 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ObjectId'
613 VnfLcmOpOccs.Get.200:
618 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ArrayOfVnfLcmOpOcc'
621 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ArrayOfVnfLcmOpOcc'
622 IndividualVnfLcmOpOcc.Get.200:
627 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc'
630 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc'
631 Subscriptions.Post.201:
641 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription'
644 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription'
645 Subscriptions.Get.200:
650 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ArrayOfLccnSubscription'
653 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ArrayOfLccnSubscription'
654 IndividualSubscription.Get.200:
659 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription'
662 $ref: './definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription'