2 "basePath": "/api/NokiaSVNFM/v1",
15 "email": "onap-discuss@lists.onap.org",
17 "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/lcm"
19 "description": "ONAP Nokia CBAM Driver API.",
20 "title": "ONAP Nokia CBAM Driver API",
29 "responseDescriptor": {
35 "description": "The progress of the job. Value between 0 and 100.",
38 "responseHistoryList": {
40 "$ref": "#/definitions/jobResponseInfo"
48 "$ref": "#/definitions/JobStatus",
49 "description": "The status of the job"
51 "statusDescription": {
52 "description": "The reason of the current status of the job.",
70 "description": "The status of the job",
81 "description": "The direction of the scaling",
91 "description": "vim info createTime",
95 "description": "vim description",
99 "description": "vim name",
103 "description": "vim login password",
107 "description": "The collection of trusted certificates towards the VIM connection.",
111 "description": "Whether to verify VIM's certificate",
115 "description": "The status of external system",
119 "description": "vim type",
123 "description": "vim url",
127 "description": "vim login username",
131 "description": "vendor name",
135 "description": "vim version",
139 "description": "vim Id",
172 "vnfInstanceDescription": {
202 "description": "VNF instance ID",
206 "description": "VNF instance name",
214 "$ref": "#/definitions/VnfInstInfo"
218 "VnfInstantiateRequest": {
225 "$ref": "#/definitions/extVirtualLinkInfo"
232 "vnfInstanceDescription": {
244 "VnfInstantiateResponse": {
258 "description": "Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled",
262 "description": "Identifies the aspect of the VNF that is requested to be scaled",
266 "description": "Number of scaling steps to be executed as part of this ScaleVnf operation. It shall be a positive number",
270 "$ref": "#/definitions/ScaleDirection",
271 "description": "The direction of the scaling."
276 "VnfTerminateRequest": {
278 "gracefulTerminationTimeout": {
279 "description": "The time interval(second) to wait for the VNF to be taken out of service during graceful termination.",
283 "$ref": "#/definitions/VnfTerminationType",
284 "description": "The type of the termination"
289 "VnfTerminationType": {
290 "description": "The type of the termination.",
297 "extVirtualLinkInfo": {
300 "resourceSubnetId": {
302 "description": "The provider id of the subnet"
306 "description": "The identifier of the virtual link"
310 "description": "The provider id of the network"
314 "description": "The identifier of the connection point descriptor"
321 "description": "The identifier of the VIM"
341 "statusDescription": {
352 "description": "Password of login user",
356 "description": "Tenant Name of tenant",
360 "description": "Username for login",
366 "interfaceEndpoint": {
367 "description": "Information about the interface endpoint. It is a URL",
373 "description": "The api Version Type value will be ",
377 "description": "The protocol Type value will be http or https",
381 "description": "The vim Type value wil be openstack",
396 "VnfLifecycleChangeNotification": {
398 "description": "The lifecycle change notifications send from CBAM"
405 "description": "The identifier of the request in SO. Used to track requests.",
408 "serviceInstanceId": {
410 "description": "The identifier of the service instance in A&AI.",
415 "SoV2VnfQueryRequest": {
420 "$ref": "#/definitions/SoMsoRequest"
425 "description": "The status of the VNF",
436 "additionalProperties": {
442 "additionalProperties": {
446 "SoV2VnfQueryResponse": {
451 "description": "The status of the VNF",
452 "$ref": "#/definitions/SoVnfStatus"
456 "SoV2VnfCreateRequest": {
462 "description": "The owner of cloud in A&AI."
467 "description": "The regionName of cloud in A&AI."
472 "description": "The identifier of the tenant."
477 "description": "The name of the VNF."
481 "description": "The inputs of the VNF.",
482 "$ref": "#/definitions/SoInput"
486 "description": "Should the VNF creation fail if the VNF already exists. (defaults to false)",
489 "deleteUponFailure": {
491 "description": "Delete VNF in case of failure. (defaults to false)",
496 "$ref": "#/definitions/SoMsoRequest"
502 "description": "Generic rollback parameters",
506 "description": "Delete the VNF if exists",
511 "description": "The identifier of the VNF in AAI",
516 "description": "The pointer to the original request that triggered the rollback",
517 "$ref": "#/definitions/SoMsoRequest"
521 "OriginalVnfProperties": {
523 "additionalProperties": {
527 "SoV2RollbackVnfUpdate": {
530 "$ref": "#/definitions/SoMsoRollback"
535 "originalVnfProperties": {
537 "description": "The original VNF properties before the operation",
538 "$ref": "#/definitions/OriginalVnfProperties"
544 "SoV2VnfUpdateRequest": {
549 "description": "The inputs of the VNF.",
550 "$ref": "#/definitions/SoInput"
554 "$ref": "#/definitions/SoMsoRequest"
558 "SoV2VnfUpdateResponse": {
561 "$ref": "#/definitions/SoV2RollbackVnfUpdate"
568 "description": "Is the update successful. The operation can be rolled back regardless of this attribute",
575 "SoV2VnfDeleteRequest": {
580 "$ref": "#/definitions/SoMsoRequest"
584 "SoV2VfModuleCreateRequest": {
589 "description": "The identifier of the scaling aspect",
594 "description": "The inputs of the VNF.",
595 "$ref": "#/definitions/SoInput"
599 "description": "Should the VNF creation fail if the VNF already exists. (defaults to false)",
602 "deleteUponFailure": {
604 "description": "Delete VF module in case of failure. (defaults to false)",
609 "$ref": "#/definitions/SoMsoRequest"
620 "description": "VNF create&instantiate Rest API should be provided by the VNFM Driver",
621 "operationId": "vnf_instantiate",
624 "description": "The value of vnfmid should be the VNFM Instantiate ID",
631 "description": "instantiate request param",
636 "$ref": "#/definitions/VnfInstantiateRequest"
647 "$ref": "#/definitions/VnfInstantiateResponse"
651 "summary": "vnf create&instantiate",
657 "/{vnfmId}/vnfs/{vnfId}": {
663 "operationId": "query_vnf",
666 "description": "The value of vnfmId should be the VNFM Instantiate ID",
673 "description": "The value of vnfId should be the VNF Instantiate ID",
685 "description": "successful operation",
687 "$ref": "#/definitions/VnfInfo"
691 "description": "the vnf instance id is wrong"
694 "description": "the url is invalid"
697 "summary": "query the specified vnf info",
703 "/{vnfmId}/vnfs/{vnfId}/heal": {
708 "description": "VNF Heal Rest API should be provided by the VNFM Driver",
709 "operationId": "vnf_heal",
712 "description": "The value of vnfmId should be the VNFM Instantiate ID",
719 "description": "The value of vnfId should be the VNF Instantiate ID",
726 "description": "instantiate request param",
731 "$ref": "#/definitions/VnfHealRequest"
742 "$ref": "#/definitions/JobInfo"
746 "description": "the VNF instance id is wrong"
749 "description": "the url is invalid"
752 "summary": "vnf heal",
758 "/{vnfmId}/vnfs/{vnfId}/scale": {
763 "description": "VNF Scale Rest API should be provided by the VNFM Driver",
764 "operationId": "vnf_scale",
767 "description": "The value of vnfmId should be the VNFM Instantiate ID",
774 "description": "The value of vnfId should be the VNF Instantiate ID",
781 "description": "instantiate request param",
786 "$ref": "#/definitions/VnfScaleRequest"
797 "$ref": "#/definitions/JobInfo"
801 "description": "the VNF instance id is wrong"
804 "description": "the url is invalid"
807 "summary": "vnf Scale",
813 "/{vnfmId}/vnfs/{vnfId}/terminate": {
818 "description": "VNF terminate&delete Rest API should be provided by the VNFM Driver",
819 "operationId": "terminate_vnf",
822 "description": "The value of vnfmId should be the VNFM Instantiate ID",
829 "description": "The value of vnfId should be the VNF Instantiate ID",
836 "description": "instantiate request param",
841 "$ref": "#/definitions/VnfTerminateRequest"
850 "description": "successful operation",
852 "$ref": "#/definitions/JobInfo"
856 "description": "the VNF instance id is wrong"
859 "description": "the url is invalid"
862 "summary": "terminate&delete vnf",
868 "/{vnfmId}/jobs/{jobId}": {
873 "summary": "jobstatus",
874 "description": "Job Infomation API should be provided by VNFM Driver",
875 "operationId": "get_jobstatus",
880 "description": "job Id",
887 "description": "The value of vnfmId should be the VNFM Instantiate ID",
894 "description": "job response message id",
895 "name": "responseId",
903 "$ref": "#/definitions/JobDetailInfo"
914 "summary": "Test LCN connectivity from CBAM to driver",
915 "description": "Test LCN connectivity from CBAM to driver",
918 "description": "Used for connectivity test"
929 "summary": "Send LCN from CBAM",
930 "description": "Test LCN connectivity from CBAM to driver",
933 "description": "The life cycle change notification",
938 "$ref": "#/definitions/VnfLifecycleChangeNotification"
944 "description": "Used for connectivity test"
954 "summary": "The Nokia SVNFM API definition",
955 "description": "The Nokia SVNFM API definition",
958 "description": "The swagger API definition"
969 "multipart/form-data"
972 "application/octet-stream"
976 "description": "The CBAM VNF package",
978 "name": "fileToUpload",
982 "description": "ONAP version of the package",
988 "summary": "Converts the Nokia CBAM package to ONAP package",
989 "description": "Converts the Nokia CBAM package to ONAP package",
992 "description": "The converted package",
1006 "summary": "UI to convert the Nokia CBAM package to ONAP package",
1007 "description": "UI to convert the Nokia CBAM package to ONAP package",
1010 "description": "The converted package"
1018 "SO VNFM Adaptor V2"
1020 "summary": "Test VNFM driver health",
1021 "description": "Test VNFM driver health",
1024 "description": "VNFM adapter is healthy"
1029 "/so/v2/vnfs/{vnfIdInAai}/rollback": {
1032 "SO VNFM Adaptor V2"
1034 "summary": "Rollback VNF update operation",
1035 "description": "Rollback VNF update operation",
1036 "operationId": "rollback",
1044 "description": "The identifier of the VNF",
1045 "name": "vnfIdInAai",
1051 "description": "Rollback parameters",
1054 "$ref": "#/definitions/SoV2RollbackVnfUpdate"
1060 "description": "Operation has been rolled back"
1065 "/so/v2/vnfs/{vnfIdInAai}": {
1068 "SO VNFM Adaptor V2"
1070 "summary": "VNF query",
1071 "description": "VNF query",
1072 "operationId": "vnf_query",
1083 "description": "The identifier of the VNF in A&AI.",
1084 "name": "vnfIdInAai",
1090 "description": "VNF creation query parameter",
1093 "$ref": "#/definitions/SoV2VnfQueryRequest"
1101 "$ref": "#/definitions/SoV2VnfQueryResponse"
1105 "descriotion": "The VNF does not exist on the VNFM side"
1111 "SO VNFM Adaptor V2"
1113 "summary": "VNF create",
1114 "description": "VNF create",
1115 "operationId": "vnf_create",
1123 "description": "The identifier of the VNF",
1124 "name": "vnfIdInAai",
1130 "description": "VNF creation query parameter",
1133 "$ref": "#/definitions/SoV2VnfCreateRequest"
1139 "description": "The VNF was created on the VNFM side."
1142 "description": "The VNF could not be instantiated on the VNFM side. Failure has been treated according to deleteUponFailure parameter"
1148 "SO VNFM Adaptor V2"
1150 "summary": "VNF update",
1151 "description": "VNF update",
1152 "operationId": "vnf_update",
1163 "description": "The identifier of the VNF",
1164 "name": "vnfIdInAai",
1170 "description": "VNF update parameter",
1173 "$ref": "#/definitions/SoV2VnfUpdateRequest"
1179 "description": "The VNF update has finished. Success is indicated in the success field.",
1181 "$ref": "#/definitions/SoV2VnfUpdateResponse"
1188 "SO VNFM Adaptor V2"
1190 "summary": "VNF delete",
1191 "description": "VNF delete",
1192 "operationId": "vnf_delete",
1200 "description": "The identifier of the VNF",
1201 "name": "vnfIdInAai",
1207 "description": "VNF delete parameter",
1210 "$ref": "#/definitions/SoV2VnfDeleteRequest"
1216 "description": "The VNF was successfully deleted."
1221 "/so/v2/vfmodule/{vnfIdInAai}/{vfModuleId}": {
1224 "SO VNFM Adaptor V2"
1226 "summary": "VF module create",
1227 "description": "VF module create",
1228 "operationId": "vf_module_create",
1236 "description": "The identifier of VNF in A&AI.",
1237 "name": "vnfIdInAai",
1243 "description": "The identifier of the VF module in A&AI",
1244 "name": "vfModuleId",
1250 "description": "VNF creation query parameter",
1253 "$ref": "#/definitions/SoV2VfModuleCreateRequest"
1259 "description": "The VF module has been created"
1265 "SO VNFM Adaptor V2"
1267 "summary": "VF module update",
1268 "description": "VF module update",
1269 "operationId": "vf_module_update",
1280 "description": "The identifier of VNF in A&AI.",
1281 "name": "vnfIdInAai",
1287 "description": "The identifier of the VF module in A&AI",
1288 "name": "vfModuleId",
1294 "description": "VNF creation query parameter",
1297 "$ref": "#/definitions/SoV2VnfUpdateRequest"
1304 "$ref": "#/definitions/SoV2VnfUpdateResponse"
1311 "SO VNFM Adaptor V2"
1313 "summary": "VF module delete",
1314 "description": "VF module delete",
1315 "operationId": "vf_module_delete",
1323 "description": "The identifier of VNF in A&AI.",
1324 "name": "vnfIdInAai",
1330 "description": "The identifier of the VF module in A&AI",
1331 "name": "vfModuleId",
1337 "description": "VNF delete parameter",
1340 "$ref": "#/definitions/SoV2VnfDeleteRequest"
1346 "description": "The VNF was successfully deleted."
1351 "/so/v2/vfmodule/{vnfIdInAai}/{vfModuleId}/rollback": {
1354 "SO VNFM Adaptor V2"
1356 "summary": "VF module update rollback",
1357 "description": "VF module update rollback",
1358 "operationId": "vf_module_update rollback",
1369 "description": "The identifier of VNF in A&AI.",
1370 "name": "vnfIdInAai",
1376 "description": "The identifier of the VF module in A&AI",
1377 "name": "vfModuleId",
1383 "description": "VNF update rollback parameter",
1386 "$ref": "#/definitions/SoV2RollbackVnfUpdate"
1392 "description": "Operation has been rolled back"