3 - description: OSM NB API
4 url: https://osm.etsi.org/nbapi/v1.0.0
7 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
8 For more information on OSM, you can visit
9 [http://osm.etsi.org](http://osm.etsi.org) or connect to IRCs
10 [Freenode, #etsi-osm](http://webchat.freenode.net?channels=etsi-osm) or on
11 [OSM IRC, #tech](https://osm.etsi.org:8080/kiwi)
13 title: OSM NB API featuring ETSI NFV SOL005
15 email: OSM_TECH@list.etsi.org
18 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
20 - name: 'VNF packages'
21 description: Management operations of VNF descriptors and packages
23 description: Management operations of NS descriptors and packages
24 - name: 'NS instances'
25 description: Management operations of NS instances
27 /nsd/v1/ns_descriptors:
31 summary: Query information about multiple NS descriptor resources
32 description: Query information about multiple NS descriptor resources
42 $ref: '#/components/schemas/ArrayOfNsdInfo'
45 $ref: '#/components/schemas/ArrayOfNsdInfo'
47 $ref: '#/components/responses/BadRequest'
49 $ref: '#/components/responses/Unauthorized'
51 $ref: '#/components/responses/Forbidden'
53 $ref: '#/components/responses/NotFound'
55 $ref: '#/components/responses/MethodNotAllowed'
57 $ref: '#/components/responses/NotAcceptable'
59 $ref: '#/components/responses/Conflict'
61 $ref: '#/components/responses/UnprocessableEntity'
63 $ref: '#/components/responses/InternalServerError'
65 $ref: '#/components/responses/ServiceUnavailable'
67 $ref: '#/components/responses/UnexpectedError'
69 $ref: '#/components/responses/UnexpectedError'
73 summary: Create a new NS descriptor resource
74 description: Create a new NS descriptor resource
79 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
91 $ref: '#/components/schemas/NsdInfo'
94 $ref: '#/components/schemas/NsdInfo'
96 $ref: '#/components/responses/BadRequest'
98 $ref: '#/components/responses/Unauthorized'
100 $ref: '#/components/responses/Forbidden'
102 $ref: '#/components/responses/NotFound'
104 $ref: '#/components/responses/MethodNotAllowed'
106 $ref: '#/components/responses/NotAcceptable'
108 $ref: '#/components/responses/Conflict'
110 $ref: '#/components/responses/UnprocessableEntity'
112 $ref: '#/components/responses/InternalServerError'
114 $ref: '#/components/responses/ServiceUnavailable'
116 $ref: '#/components/responses/UnexpectedError'
118 $ref: '#/components/responses/UnexpectedError'
119 '/nsd/v1/ns_descriptors/{nsdInfoId}':
123 summary: Read information about an individual NS descriptor resource
124 description: Read information about an individual NS descriptor resource
134 $ref: '#/components/schemas/NsdInfo'
137 $ref: '#/components/schemas/NsdInfo'
139 $ref: '#/components/responses/BadRequest'
141 $ref: '#/components/responses/Unauthorized'
143 $ref: '#/components/responses/Forbidden'
145 $ref: '#/components/responses/NotFound'
147 $ref: '#/components/responses/MethodNotAllowed'
149 $ref: '#/components/responses/NotAcceptable'
151 $ref: '#/components/responses/Conflict'
153 $ref: '#/components/responses/UnprocessableEntity'
155 $ref: '#/components/responses/InternalServerError'
157 $ref: '#/components/responses/ServiceUnavailable'
159 $ref: '#/components/responses/UnexpectedError'
161 $ref: '#/components/responses/UnexpectedError'
165 summary: Delete an individual NS descriptor resource
166 description: Delete an individual NS descriptor resource
167 operationId: deleteNSD
172 description: No Content
174 $ref: '#/components/responses/BadRequest'
176 $ref: '#/components/responses/Unauthorized'
178 $ref: '#/components/responses/Forbidden'
180 $ref: '#/components/responses/NotFound'
182 $ref: '#/components/responses/MethodNotAllowed'
184 $ref: '#/components/responses/NotAcceptable'
186 $ref: '#/components/responses/Conflict'
188 $ref: '#/components/responses/UnprocessableEntity'
190 $ref: '#/components/responses/InternalServerError'
192 $ref: '#/components/responses/ServiceUnavailable'
194 $ref: '#/components/responses/UnexpectedError'
196 $ref: '#/components/responses/UnexpectedError'
200 summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource
201 description: Modify the operational state and/or the user defined data of an individual NS descriptor resource
202 operationId: updateNSD
206 $ref: '#/components/requestBodies/NsdInfoModifications'
213 $ref: '#/components/schemas/NsdInfoModifications'
216 $ref: '#/components/schemas/NsdInfoModifications'
218 $ref: '#/components/responses/BadRequest'
220 $ref: '#/components/responses/Unauthorized'
222 $ref: '#/components/responses/Forbidden'
224 $ref: '#/components/responses/NotFound'
226 $ref: '#/components/responses/MethodNotAllowed'
228 $ref: '#/components/responses/NotAcceptable'
230 $ref: '#/components/responses/Conflict'
232 $ref: '#/components/responses/UnprocessableEntity'
234 $ref: '#/components/responses/InternalServerError'
236 $ref: '#/components/responses/ServiceUnavailable'
238 $ref: '#/components/responses/UnexpectedError'
240 $ref: '#/components/responses/UnexpectedError'
241 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
245 summary: Fetch the content of a NSD
246 description: Fetch the content of a NSD
247 operationId: getNSDcontent
253 $ref: '#/components/requestBodies/NsdContent'
255 description: Partial Content
260 $ref: '#/components/requestBodies/NsdContent'
262 $ref: '#/components/responses/BadRequest'
264 $ref: '#/components/responses/Unauthorized'
266 $ref: '#/components/responses/Forbidden'
268 $ref: '#/components/responses/NotFound'
270 $ref: '#/components/responses/MethodNotAllowed'
272 $ref: '#/components/responses/NotAcceptable'
274 $ref: '#/components/responses/Conflict'
276 $ref: '#/components/responses/UnprocessableEntity'
278 $ref: '#/components/responses/InternalServerError'
280 $ref: '#/components/responses/ServiceUnavailable'
282 $ref: '#/components/responses/UnexpectedError'
284 $ref: '#/components/responses/UnexpectedError'
288 summary: Upload the content of a NSD
289 description: Upload the content of a NSD
290 operationId: updateNSDcontent
294 $ref: '#/components/requestBodies/NsdContent'
297 description: Accepted
299 description: No Content
301 $ref: '#/components/responses/BadRequest'
303 $ref: '#/components/responses/Unauthorized'
305 $ref: '#/components/responses/Forbidden'
307 $ref: '#/components/responses/NotFound'
309 $ref: '#/components/responses/MethodNotAllowed'
311 $ref: '#/components/responses/NotAcceptable'
313 $ref: '#/components/responses/Conflict'
315 $ref: '#/components/responses/UnprocessableEntity'
317 $ref: '#/components/responses/InternalServerError'
319 $ref: '#/components/responses/ServiceUnavailable'
321 $ref: '#/components/responses/UnexpectedError'
323 $ref: '#/components/responses/UnexpectedError'
324 /vnfpkgm/v1/vnf_packages:
328 summary: Query information about multiple VNF package resources
329 description: Query information about multiple VNF package resoureces
330 operationId: getVnfPkgs
339 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
342 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
344 $ref: '#/components/responses/BadRequest'
346 $ref: '#/components/responses/Unauthorized'
348 $ref: '#/components/responses/Forbidden'
350 $ref: '#/components/responses/NotFound'
352 $ref: '#/components/responses/MethodNotAllowed'
354 $ref: '#/components/responses/NotAcceptable'
356 $ref: '#/components/responses/Conflict'
358 $ref: '#/components/responses/UnprocessableEntity'
360 $ref: '#/components/responses/InternalServerError'
362 $ref: '#/components/responses/ServiceUnavailable'
364 $ref: '#/components/responses/UnexpectedError'
366 $ref: '#/components/responses/UnexpectedError'
370 summary: Create a new VNF package resource
371 description: Create a new VNF package resource
372 operationId: addVnfPkg
376 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
388 $ref: '#/components/schemas/VnfPkgInfo'
391 $ref: '#/components/schemas/VnfPkgInfo'
393 $ref: '#/components/responses/BadRequest'
395 $ref: '#/components/responses/Unauthorized'
397 $ref: '#/components/responses/Forbidden'
399 $ref: '#/components/responses/NotFound'
401 $ref: '#/components/responses/MethodNotAllowed'
403 $ref: '#/components/responses/NotAcceptable'
405 $ref: '#/components/responses/Conflict'
407 $ref: '#/components/responses/UnprocessableEntity'
409 $ref: '#/components/responses/InternalServerError'
411 $ref: '#/components/responses/ServiceUnavailable'
413 $ref: '#/components/responses/UnexpectedError'
415 $ref: '#/components/responses/UnexpectedError'
416 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
420 summary: Read information about an individual VNF package resource
421 description: Read information about an individual VNF package resource
422 operationId: getVnfPkg
431 $ref: '#/components/schemas/VnfPkgInfo'
434 $ref: '#/components/schemas/VnfPkgInfo'
436 $ref: '#/components/responses/BadRequest'
438 $ref: '#/components/responses/Unauthorized'
440 $ref: '#/components/responses/Forbidden'
442 $ref: '#/components/responses/NotFound'
444 $ref: '#/components/responses/MethodNotAllowed'
446 $ref: '#/components/responses/NotAcceptable'
448 $ref: '#/components/responses/Conflict'
450 $ref: '#/components/responses/UnprocessableEntity'
452 $ref: '#/components/responses/InternalServerError'
454 $ref: '#/components/responses/ServiceUnavailable'
456 $ref: '#/components/responses/UnexpectedError'
458 $ref: '#/components/responses/UnexpectedError'
462 summary: Delete an individual VNF package resource
463 description: Delete an individual VNF package resource
464 operationId: deleteVnfPkg
469 description: No Content
471 $ref: '#/components/responses/BadRequest'
473 $ref: '#/components/responses/Unauthorized'
475 $ref: '#/components/responses/Forbidden'
477 $ref: '#/components/responses/NotFound'
479 $ref: '#/components/responses/MethodNotAllowed'
481 $ref: '#/components/responses/NotAcceptable'
483 $ref: '#/components/responses/Conflict'
485 $ref: '#/components/responses/UnprocessableEntity'
487 $ref: '#/components/responses/InternalServerError'
489 $ref: '#/components/responses/ServiceUnavailable'
491 $ref: '#/components/responses/UnexpectedError'
493 $ref: '#/components/responses/UnexpectedError'
497 summary: Modify the operational state and/or the user defined data of an individual VNF package resource
498 description: Modify the operational state and/or the user defined data of an individual VNF package resource
499 operationId: updateVnfPkg
503 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
510 $ref: '#/components/schemas/VnfPkgInfoModifications'
513 $ref: '#/components/schemas/VnfPkgInfoModifications'
515 $ref: '#/components/responses/BadRequest'
517 $ref: '#/components/responses/Unauthorized'
519 $ref: '#/components/responses/Forbidden'
521 $ref: '#/components/responses/NotFound'
523 $ref: '#/components/responses/MethodNotAllowed'
525 $ref: '#/components/responses/NotAcceptable'
527 $ref: '#/components/responses/Conflict'
529 $ref: '#/components/responses/UnprocessableEntity'
531 $ref: '#/components/responses/InternalServerError'
533 $ref: '#/components/responses/ServiceUnavailable'
535 $ref: '#/components/responses/UnexpectedError'
537 $ref: '#/components/responses/UnexpectedError'
538 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
542 summary: Read VNFD of an on-boarded VNF package
543 description: Read VNFD of an on-boarded VNF package
544 operationId: getVnfPkgVNFD
553 $ref: '#/components/schemas/VnfDescriptor'
555 $ref: '#/components/responses/BadRequest'
557 $ref: '#/components/responses/Unauthorized'
559 $ref: '#/components/responses/Forbidden'
561 $ref: '#/components/responses/NotFound'
563 $ref: '#/components/responses/MethodNotAllowed'
565 $ref: '#/components/responses/NotAcceptable'
567 $ref: '#/components/responses/Conflict'
569 $ref: '#/components/responses/UnprocessableEntity'
571 $ref: '#/components/responses/InternalServerError'
573 $ref: '#/components/responses/ServiceUnavailable'
575 $ref: '#/components/responses/UnexpectedError'
577 $ref: '#/components/responses/UnexpectedError'
578 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
582 summary: Fetch an on-boarded VNF package
583 description: Fetch an on-boarded VNF package
584 operationId: getVnfPkgContent
593 $ref: '#/components/schemas/VnfPackage'
595 description: Partial Content
603 $ref: '#/components/schemas/VnfPackage'
605 $ref: '#/components/responses/BadRequest'
607 $ref: '#/components/responses/Unauthorized'
609 $ref: '#/components/responses/Forbidden'
611 $ref: '#/components/responses/NotFound'
613 $ref: '#/components/responses/MethodNotAllowed'
615 $ref: '#/components/responses/NotAcceptable'
617 $ref: '#/components/responses/Conflict'
619 $ref: '#/components/responses/UnprocessableEntity'
621 $ref: '#/components/responses/InternalServerError'
623 $ref: '#/components/responses/ServiceUnavailable'
625 $ref: '#/components/responses/UnexpectedError'
627 $ref: '#/components/responses/UnexpectedError'
631 summary: Upload a VNF package by providing the content of the VNF package
632 description: Upload a VNF package by providing the content of the VNF package
633 operationId: uploadVnfPkgContent
637 $ref: '#/components/requestBodies/VnfPackage'
640 description: Accepted
642 # description: No Content
644 $ref: '#/components/responses/BadRequest'
646 $ref: '#/components/responses/Unauthorized'
648 $ref: '#/components/responses/Forbidden'
650 $ref: '#/components/responses/NotFound'
652 $ref: '#/components/responses/MethodNotAllowed'
654 $ref: '#/components/responses/NotAcceptable'
656 $ref: '#/components/responses/Conflict'
658 $ref: '#/components/responses/UnprocessableEntity'
660 $ref: '#/components/responses/InternalServerError'
662 $ref: '#/components/responses/ServiceUnavailable'
664 $ref: '#/components/responses/UnexpectedError'
666 $ref: '#/components/responses/UnexpectedError'
667 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/upload_from_uri':
671 summary: Upload a VNF package by providing the URI of the VNF package
672 description: Upload a VNF package by providing the URI of the VNF package
673 operationId: uploadVnfPkgContentFromURI
677 $ref: '#/components/requestBodies/UploadVnfPackageFromUriRequest'
680 description: Accepted
682 # description: No Content
684 $ref: '#/components/responses/BadRequest'
686 $ref: '#/components/responses/Unauthorized'
688 $ref: '#/components/responses/Forbidden'
690 $ref: '#/components/responses/NotFound'
692 $ref: '#/components/responses/MethodNotAllowed'
694 $ref: '#/components/responses/NotAcceptable'
696 $ref: '#/components/responses/Conflict'
698 $ref: '#/components/responses/UnprocessableEntity'
700 $ref: '#/components/responses/InternalServerError'
702 $ref: '#/components/responses/ServiceUnavailable'
704 $ref: '#/components/responses/UnexpectedError'
706 $ref: '#/components/responses/UnexpectedError'
707 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
711 summary: Fetch individual VNF package artifact
712 description: Fetch individual VNF package artifact
713 operationId: getVnfPkgArtifact
720 application/octet-stream:
725 description: Partial Content
731 application/octet-stream:
736 $ref: '#/components/responses/BadRequest'
738 $ref: '#/components/responses/Unauthorized'
740 $ref: '#/components/responses/Forbidden'
742 $ref: '#/components/responses/NotFound'
744 $ref: '#/components/responses/MethodNotAllowed'
746 $ref: '#/components/responses/NotAcceptable'
748 $ref: '#/components/responses/Conflict'
750 $ref: '#/components/responses/UnprocessableEntity'
752 $ref: '#/components/responses/InternalServerError'
754 $ref: '#/components/responses/ServiceUnavailable'
756 $ref: '#/components/responses/UnexpectedError'
758 $ref: '#/components/responses/UnexpectedError'
760 description: Find out more OSM
761 url: 'http://osm.etsi.org/wikipub'
765 description: Bad request. The server cannot process the request due to a client error.
769 $ref: '#/components/schemas/ProblemDetails'
771 description: Authorization information is missing or invalid.
775 $ref: '#/components/schemas/ProblemDetails'
777 description: Not enough permissions to do this operation.
781 $ref: '#/components/schemas/ProblemDetails'
783 description: The specified resource was not found.
787 $ref: '#/components/schemas/ProblemDetails'
789 description: This method is not supported for the requested resource.
793 $ref: '#/components/schemas/ProblemDetails'
795 description: The requested resource content cannot match the Accept headers sent in the request.
799 $ref: '#/components/schemas/ProblemDetails'
801 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
805 $ref: '#/components/schemas/ProblemDetails'
807 description: The request was well-formed but was unable to be followed due to semantic errors.
811 $ref: '#/components/schemas/ProblemDetails'
813 description: Internal server error.
817 $ref: '#/components/schemas/ProblemDetails'
819 description: Service temporarily unavailable.
823 $ref: '#/components/schemas/ProblemDetails'
825 description: Unexpected error.
829 $ref: '#/components/schemas/ProblemDetails'
838 additionalProperties:
840 CreateNsdInfoRequest:
844 $ref: '#/components/schemas/KeyValuePairs'
845 NsdOnboardingStateType:
847 enum: [CREATED, UPLAODING, PROCESSING, ONBOARDED]
849 NSD onboarding state:
850 * `CREATED` - The NSD information object is created.
851 * `UPLOADING` - The associated NSD content is being uploaded.
852 * `PROCESSING` - The associated NSD content is being processed, e.g. validation.
853 * `ONBOARDED` - The associated NSD content is on-boarded.
854 NsdOperationalStateType:
856 enum: [ENABLED, DISABLED]
858 NSD operational state:
859 * `ENABLED` - The NSD is enabled.
860 * `DISABLED` - The NSD is disabled.
863 enum: [IN_USE, NOT_IN_USE]
866 * `IN_USE` - The NSD is in use.
867 * `NOT_IN_USE` - The NSD is not in use.
868 NsdInfoModifications:
872 $ref: '#/components/schemas/NsdOperationalStateType'
874 $ref: '#/components/schemas/KeyValuePairs'
880 Identifier of the onboarded individual NS descriptor
881 resource. This identifier is allocated by the NFVO.
886 This identifier, which is allocated by the NSD
887 designer, identifies the NSD in a globally unique
888 way. It is copied from the NSD content and shall be
889 present after the NSD content is on-boarded.
894 Name of the onboarded NSD. This information is
895 copied from the NSD content and shall be present
896 after the NSD content is on-boarded.
900 Version of the on-boarded NSD. This information is
901 copied from the NSD content and shall be present
902 after the NSD content is on-boarded.
906 Designer of the on-boarded NSD. This information is
907 copied from the NSD content and shall be present
908 after the NSD content is on-boarded.
912 This identifier, which is allocated by the NSD designer,
913 identifies an NSD in a version independent manner. This
914 information is copied from the NSD content and shall be
915 present after the NSD content is on-boarded.
920 List of VNF package identifiers referenced by the on-boarded
921 NS descriptor resource.
928 List of PNFD identifiers referenced by the on-boarded NS
936 List of NSD identifiers referenced by the on-boarded NS
944 Onboarding state of the individual NS descriptor resource.
945 $ref: '#components/schemas/NsdOnboardingStateType'
946 onboardingFailureDetails:
948 Failure details of current onboarding procedure. It follows
949 the "ProblemDetails" structure. It shall be present when the
950 "nsdOnboardingState" attribute is CREATED and the uploading or
951 processing fails in NFVO.
952 $ref: '#/components/schemas/ProblemDetails'
955 Operational state of the individual NS descriptor resource. This
956 attribute can be modified with the PATCH method. If the value of
957 the nsdOnboardingState attribute is not equal to "ONBOARDED", the
958 value of the nsdOperationalState attribute shall be equal to
960 $ref: '#components/schemas/NsdOperationalStateType'
963 Usage state of the individual NS descriptor resource. If the value
964 of the nsdOnboardingState attribute is not equal to "ONBOARDED",
965 the value of the nsdUsageState attribute shall be equal to
967 $ref: '#components/schemas/NsdUsageStateType'
969 $ref: '#/components/schemas/KeyValuePairs'
972 Links to resources related to this resource
981 Link to the NSD content resource.
987 - nsdOperationalState
995 $ref: '#/components/schemas/NsdInfo'
1011 additionalProperties: true
1020 CreateVnfPkgInfoRequest:
1024 $ref: '#/components/schemas/KeyValuePairs'
1025 VnfPackageOnboardingStateType:
1027 enum: [CREATED, UPLAODING, PROCESSING, ONBOARDED]
1029 VNF Package onboarding state:
1030 * `CREATED` - The VNF Package information object is created.
1031 * `UPLOADING` - The VNF Package is being uploaded.
1032 * `PROCESSING` - The VNF Package is being processed, e.g. validation.
1033 * `ONBOARDED` - The VNF Package is successfully on-boarded.
1034 VnfPackageOperationalStateType:
1036 enum: [ENABLED, DISABLED]
1038 VNF Package operational state:
1039 * `ENABLED` - The VNF Package is enabled.
1040 * `DISABLED` - The VNF Package is disabled.
1041 VnfPackageUsageStateType:
1043 enum: [IN_USE, NOT_IN_USE]
1045 VNF Package usage state:
1046 * `IN_USE` - The VNF Package is in use.
1047 * `NOT_IN_USE` - The VNF Package is not in use.
1048 #SoftwareImageFormatType:
1050 # enum: [AKI, AMI, ARI, BARE, DOCKER, OVA, OVF]
1052 # Software image format. Permitted values:
1053 # * `AKI`: a kernel image format
1054 # * `AMI`: a machine image format
1055 # * `ARI`: a ramdisk image format
1056 # * `BARE`: the image does not have a container or metadata envelope
1057 # * `DOCKER`: docker container format
1058 # * `OVA`: OVF package in a tarfile
1059 # * `OVF`: OVF container format
1060 VnfPackageSoftwareImageInfo:
1062 additionalProperties: true
1066 # Identifier of the software image, unique in the scope of a VNFD.
1070 # Name of the software image.
1074 # Provider of the software image.
1078 # Version of the software image.
1082 # Checksum of the software image file.
1086 # Container format indicates whether the software image is in a
1087 # file format that also contains metadata about the actual
1089 # $ref: '#/components/schemas/SoftwareImageFormatType'
1092 # Disk format of a software image is the format of the underlying
1094 # $ref: '#/components/schemas/DiskFormatType'
1096 VnfPackageArtifactInfo:
1098 additionalProperties: true
1099 VnfPkgInfoModifications:
1103 $ref: '#/components/schemas/VnfPackageOperationalStateType'
1105 $ref: '#/components/schemas/KeyValuePairs'
1111 Identifier of the VNF package. This identifier is allocated by the NFVO.
1116 This identifier, which is managed by the VNF provider, identifies
1117 the VNF package and the VNFD in a globally unique way. It's
1118 copied from the VNFD of the on-boarded VNF package. It shall be
1119 present after the VNF package content has been on-boarded and
1125 Deovider of the VNF pacakge and the VNFD. This information is
1126 copied from the VNFD. It shall be present after the VNF package
1127 content has been on-boarded and absent otherwise.
1131 Name to identify the VNF product. Invariant for the VNF product
1132 ligetime. This information is copied from the VNFD. It shall be
1133 present after the VNF package content has been on-boarded and
1138 Software version of the VNF. This is changed when there is any
1139 change to the software included in the VNF package. This
1140 information is copied from the VNFD. It shall be present after the
1141 VNF package content has been on-boarded and absent otherwise.
1145 The version of the VNFD. TSof information is copied from the VNFD.
1146 It shall be present after the VNF package content has been
1147 on-boarded and absent otherwise.
1151 Checksum of the on-boarded VNF package. It shall be present after
1152 the VNF package content has been on-boarded and absent otherwise.
1156 Information about VNF package artifacts that are software images.
1157 This attribute shall not be present before the VNF package content
1158 is on-boarded. Otherwise, this attribute shall be present unless
1159 it has been requested to be excluded per attribute selector.
1162 $ref: '#/components/schemas/VnfPackageSoftwareImageInfo'
1163 additionalArtifacts:
1165 Information about VNF package artifacts contained in the VNF
1166 package that are not software images. This attribute shall not be
1167 present before the VNF package content is on-boarded. Otherwise,
1168 this attribute shall be present if the VNF package contains
1169 additional artifacts.
1172 $ref: '#/components/schemas/VnfPackageArtifactInfo'
1175 On-boarding state of the VNF package.
1176 $ref: '#components/schemas/VnfPackageOnboardingStateType'
1179 Operational state of the VNF package. If the value of the
1180 onboardingState attribute is not equal to "ONBOARDED", the value
1181 of the operationalState attribute shall be equal to "DISABLED".
1182 $ref: '#components/schemas/VnfPackageOperationalStateType'
1185 Usage state of the VNF package. If the value of the
1186 onboardingState attribute is not equal to "ONBOARDED", the value
1187 of the usageState attribute shall be equal to "NOT_IN_USE".
1188 $ref: '#components/schemas/VnfPackageUsageStateType'
1191 User defined data for the VNF package
1192 $ref: '#/components/schemas/KeyValuePairs'
1195 Links to resources related to this resource
1199 URI of this resource
1204 Link to the VNFD resource. This link shall be present after the VNF
1205 package content is on-boarded.
1210 Link to the "VNF package content" resource.
1224 $ref: '#/components/schemas/VnfPkgInfo'
1225 UploadVnfPackageFromUriRequest:
1230 Address information of the VNF package content. The NFVO can use
1231 this address to obtain the VNF package.
1236 User name to be used for authentication. Shall be present if user
1237 name is needed but has not been provisioned out of band.
1241 Password to be used for authentication. Shall be present if password
1242 is needed but has not been provisioned out of band.
1245 - addressInformation
1247 CreateNsdInfoRequest:
1251 $ref: '#/components/schemas/CreateNsdInfoRequest'
1254 $ref: '#/components/schemas/CreateNsdInfoRequest'
1255 NsdInfoModifications:
1259 $ref: '#/components/schemas/NsdInfoModifications'
1262 $ref: '#/components/schemas/NsdInfoModifications'
1267 $ref: '#/components/schemas/NsDescriptor'
1270 $ref: '#/components/schemas/NsPackage'
1271 CreateVnfPkgInfoRequest:
1275 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
1278 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
1279 VnfPkgInfoModifications:
1283 $ref: '#/components/schemas/VnfPkgInfoModifications'
1286 $ref: '#/components/schemas/VnfPkgInfoModifications'
1291 $ref: '#/components/schemas/VnfPackage'
1292 UploadVnfPackageFromUriRequest:
1296 $ref: '#/components/schemas/UploadVnfPackageFromUriRequest'
1299 $ref: '#/components/schemas/UploadVnfPackageFromUriRequest'