Skip to content
Snippets Groups Projects
grant.schema.json 41.3 KiB
Newer Older
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
	"description": "This type represents a grant.\n",
	"type": "object",
	"required": [
		"id",
		"vnfInstanceId",
		"vnfLcmOpOccId",
		"_links"
	],
	"properties": {
		"id": {
			"description": "An identifier with the intention of being globally unique.\n",
			"type": "string"
		},
		"vnfInstanceId": {
			"description": "An identifier with the intention of being globally unique.\n",
			"type": "string"
		},
		"vnfLcmOpOccId": {
			"description": "An identifier with the intention of being globally unique.\n",
			"type": "string"
		},
		"vimConnectionInfo": {
			"description": "Provides information regarding VIM connections that are approved to be used by the VNFM to allocate resources, and provides parameters of these VIM connections. The VNFM shall update the \" vimConnectionInfo\" attribute of the \"VnfInstance\" structure by adding unknown entries received in this attribute. This attribute is not intended for the modification of vimConnectionInfo entries passed earlier; for that, the VnfInfoModificationRequest structure shall be used. This attribute shall only be supported when VNF-related Resource Management in direct mode is applicable. In direct mode, this parameter shall be absent if the VIM information was configured to the VNFM in another way, present otherwise. This interface allows to signal the use of multiple VIMs per VNF. However, due to the partial support of this feature in the present release, it is recommended in the present document that the number of entries in the \"vims\" attribute in the Grant is not greater than 1.\n",
			"type": "object",
			"additionalProperties": {
				"description": "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
				"type": "object",
				"required": [
					"vimType"
				],
				"properties": {
					"vimId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"vimType": {
						"description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n",
						"type": "string"
					},
					"interfaceInfo": {
						"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
						"type": "object"
					},
					"accessInfo": {
						"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
						"type": "object"
					},
					"extra": {
						"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
						"type": "object"
					}
				}
			}
		},
		"zones": {
			"description": "Identifies resource zones where the resources are approved to be allocated by the VNFM.\n",
			"type": "array",
			"items": {
				"description": "This type provides information regarding a resource zone.\n",
				"type": "object",
				"required": [
					"id",
					"zoneId"
				],
				"properties": {
					"id": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"zoneId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"vimConnectionId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceProviderId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					}
				}
			}
		},
		"zoneGroups": {
			"description": "Information about groups of resource zones that are related and that the NFVO has chosen to fulfil a zoneGroup constraint in the GrantVnfLifecycleOperation request. This information confirms that the NFVO has honoured the zoneGroup constraints that were passed as part of \"placementConstraints\" in the GrantRequest.\n",
			"type": "array",
			"items": {
				"description": "This type provides information regarding a resource zone group. A resource zone group is a group of one or more related resource zones which can be used in resource placement constraints. To fulfil such constraint, the NFVO may decide to place a resource into any zone that belongs to a particular group. NOTE: A resource zone group can be used to support overflow from one resource zone into another, in case a particular deployment supports only non-elastic resource zones.\n",
				"type": "object",
				"required": [
					"zoneId"
				],
				"properties": {
					"zoneId": {
						"description": "References of identifiers of \"ZoneInfo\" structures, each of which provides information about a resource zone that belongs to this group.\n",
						"type": "array",
						"items": {
							"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
							"type": "string"
						}
					}
				}
			}
		},
		"addResources": {
			"description": "List of resources that are approved to be added, with one entry per resource. Shall be set when resources are approved to be added.\n",
			"type": "array",
			"items": {
				"description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
				"type": "object",
				"required": [
					"resourceDefinitionId"
				],
				"properties": {
					"resourceDefinitionId": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"reservationId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					},
					"vimConnectionId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceProviderId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"zoneId": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"resourceGroupId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					}
				}
			}
		},
		"tempResources": {
			"description": "List of resources that are approved to be temporarily instantiated during the runtime of the lifecycle operation, with one entry per resource. Shall be set when resources are approved to be temporarily  instantiated.\n",
			"type": "array",
			"items": {
				"description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
				"type": "object",
				"required": [
					"resourceDefinitionId"
				],
				"properties": {
					"resourceDefinitionId": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"reservationId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					},
					"vimConnectionId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceProviderId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"zoneId": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"resourceGroupId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					}
				}
			}
		},
		"removeResources": {
			"description": "List of resources that are approved to be removed, with one entry per resource. Shall be set when resources are approved to be removed.\n",
			"type": "array",
			"items": {
				"description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
				"type": "object",
				"required": [
					"resourceDefinitionId"
				],
				"properties": {
					"resourceDefinitionId": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"reservationId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					},
					"vimConnectionId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceProviderId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"zoneId": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"resourceGroupId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					}
				}
			}
		},
		"updateResources": {
			"description": "List of resources that are approved to be modified, with one entry per resource. Shall be set when resources are approved to be updated.\n",
			"type": "array",
			"items": {
				"description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
				"type": "object",
				"required": [
					"resourceDefinitionId"
				],
				"properties": {
					"resourceDefinitionId": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"reservationId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					},
					"vimConnectionId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceProviderId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"zoneId": {
						"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
						"type": "string"
					},
					"resourceGroupId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					}
				}
			}
		},
		"vimAssets": {
			"description": "Information about assets for the VNF that are managed by the NFVO in the VIM, such as software images and virtualised compute resource flavours. The Grant response allows the NFVO to pass to the VNFM VIM assets related to the VNF package that is identified by the vnfdId attribute in the corresponding Grant request. The NFVO may send in each Grant response the full set of VIM assets related to the VNF package defined by the vnfdId in the related Grant request, but shall send this information if the vnfdId in the related Grant request differs from the vnfdId passed in the previous Grant request, or if the Grant response is related to an InstantiateVnf operation. The set of VIM assets shall not change between subsequent Grant responses if the vnfdId has not changed. During each LCM operation occurrence, the VIM assets that relate to the VNF package identified by the current value of the vnfdId attribute in the “VnfInstance” structure shall be used by the VNFM for newly created resources. If the VNF package identifier of the VNF instance has been updated, VIM assets that relate to the previously-used VNF package(s), and that were communicated in previous Grant responses, apply to existing resources.\n",
			"type": "object",
			"properties": {
				"computeResourceFlavours": {
					"description": "Mappings between virtual compute descriptors defined in the VNFD and compute resource flavours managed in the VIM.\n",
					"type": "array",
					"items": {
						"description": "If the VIM requires the use of virtual compute resource flavours during compute resource instantiation, it is assumed that such flavours are selected or created by the NFVO based on the information in the virtual compute descriptor defined in the VNFD. This type defines the mapping between a virtual compute descriptor in the VNFD and the corresponding compute resource flavour managed by the NFVO in the VIM.\n",
						"type": "object",
						"required": [
							"vnfdVirtualComputeDescId",
							"vimFlavourId"
						],
						"properties": {
							"vimConnectionId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"resourceProviderId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"vnfdVirtualComputeDescId": {
								"description": "An identifier that is unique within a VNF descriptor.\n",
								"type": "string"
							},
							"vimFlavourId": {
								"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
								"type": "string"
							}
						}
					}
				},
				"softwareImages": {
					"description": "Mappings between software images defined in the VNFD and software images managed in the VIM.\n",
					"type": "array",
					"items": {
						"description": "This type contains a mapping between a software image definition the VNFD and the corresponding software image managed by the NFVO in the VIM which is needed during compute resource instantiation.\n",
						"type": "object",
						"required": [
							"vnfdSoftwareImageId",
							"vimSoftwareImageId"
						],
						"properties": {
							"vimConnectionId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"resourceProviderId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"vnfdSoftwareImageId": {
								"description": "An identifier that is unique within a VNF descriptor.\n",
								"type": "string"
							},
							"vimSoftwareImageId": {
								"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
								"type": "string"
							}
						}
					}
				},
				"snapshotResources": {
					"description": "Mappings between snapshot resources defined in the VNF snapshot package and resources managed in the VIM.\n",
					"type": "array",
					"items": {
						"description": "This type contains a mapping between a snapshot resource definition related to a VNF snapshot  and the corresponding resource managed by the NFVO in the VIM which is needed during the revert  to VNF snapshot operation.\n",
						"type": "object",
						"required": [
							"vnfSnapshotId",
							"vnfcSnapshotId",
							"vimSnapshotResourceId"
						],
						"properties": {
							"vimConnectionId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"resourceProviderId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"vnfSnapshotId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"vnfcSnapshotId": {
								"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
								"type": "string"
							},
							"storageSnapshotId": {
								"description": "Identifier of the virtual storage resource that has been snapshotted as referred in the VNFC snapshot information. Shall only be present if the snapshot resource in the VIM is a storage  resource (as indicated by \"type=STORAGE\" in the parent resource definition). $ref: \"../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf\"\n"
							},
							"vimSnapshotResourceId": {
								"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
								"type": "string"
							}
						}
					}
				}
			}
		},
		"extVirtualLinks": {
			"description": "Information about external VLs to connect the VNF to. External and/or externally-managed internal VLs can be passed in VNF lifecycle management operation requests such as InstantiateVnf, ChangeVnfFlavor,  ChangeExtVnfConnectivity or ChangeCurrentVnfPackage and/or in the grant response.  The NFVO may choose to override in the grant response external and/or  externally-managed VL instances that have been passed previously in the  associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself. In case of granting an InstantiateVnf request that has originated from the NFVO  and that did not contain the \"extVirtualLinks\" attribute, this attribute shall be  set by the NFVO. Further in case of granting an InstantiateVnf request that has  originated from the NFVO and that did not contain the \"extManagedVirtualLinks\"  attribute, this attribute shall be set by the NFVO if there is the need to provide  information about externally-managed virtual links.\nIf this attribute is present , it need not contain those entries that are unchanged compared to the entries that were passed in the LCM operation which is related to this granting exchange. External and/or externally-managed internal VLs can be passed in VNF lifecycle management operation requests such as InstantiateVnf, ChangeVnfFlavor,  ChangeExtVnfConnectivity or ChangeCurrentVnfPackage and/or in the grant response.  The NFVO may choose to override in the grant response external and/or  externally-managed VL instances that have been passed previously in the  associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself. In case of granting an InstantiateVnf request that has originated from the NFVO  and that did not contain the \"extVirtualLinks\" attribute, this attribute shall be  set by the NFVO. Further in case of granting an InstantiateVnf request that has  originated from the NFVO and that did not contain the \"extManagedVirtualLinks\"  attribute, this attribute shall be set by the NFVO if there is the need to provide  information about externally-managed virtual links.\n",
			"type": "array",
			"items": {
				"description": "This type represents an external VL.\n",
				"type": "object",
				"required": [
					"id",
					"resourceId",
					"extCps"
				],
				"properties": {
					"id": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"vimConnectionId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceProviderId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					},
					"extCps": {
						"description": "External CPs of the VNF to be connected to this external VL.\n",
						"type": "array",
						"items": {
							"description": "This type represents configuration information for external CPs created from a CPD.\n",
							"type": "object",
							"required": [
								"cpdId"
							],
							"properties": {
								"cpdId": {
									"description": "An identifier that is unique within a VNF descriptor.\n",
									"type": "string"
								},
								"cpConfig": {
									"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure.\n",
									"type": "object",
									"additionalProperties": {
										"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
										"anyOf": [{
												"required": [
													"linkPortId"
												]
											},
											{
												"required": [
													"cpProtocolData"
												]
											}
										],
										"type": "object",
										"properties": {
											"parentCpConfigId": {
												"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
												"type": "string"
											},
											"linkPortId": {
												"description": "An identifier with the intention of being globally unique.\n",
												"type": "string"
											},
											"cpProtocolData": {
												"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": 1) Void 2) At least one of the \"linkPortId\" and \"cpProtocolData\" attributes \n   shall be present for an external CP instance representing a subport \n   that is to be created, or an external CP instance that is to be created \n   by creating the corresponding VNFC or VNF instance during the current or \n   a subsequent LCM operation, or for an existing external CP instance \n   that is to be re-configured or added to a particular external virtual link.\n3) If the \"linkPortId\" attribute is absent, the VNFM shall create a\n   link port.\n4) If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n   attribute shall be provided referencing a pre-created link port,\n   and the VNFM can use means outside the scope of the present\n   document to obtain the pre-configured address information for the\n   connection point from the resource representing the link port.\n5) If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n   consumer shall ensure that the cpProtocolData can be used with the\n   pre-created link port referenced by \"linkPortId\".\n",
												"type": "array",
												"items": {
													"description": "This type represents network protocol data.\n",
													"type": "object",
													"required": [
														"layerProtocol"
													],
													"properties": {
														"layerProtocol": {
															"description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
															"type": "string",
															"enum": [
																"IP_OVER_ETHERNET"
															]
														},
														"ipOverEthernet": {
															"description": "This type represents network address data for IP over Ethernet.\n",
															"type": "object",
															"anyOf": [{
																	"required": [
																		"macAddress"
																	]
																},
																{
																	"required": [
																		"ipAddresses"
																	]
																}
															],
															"oneOf": [{
																	"required": [
																		"fixedAddresses"
																	]
																},
																{
																	"required": [
																		"numDynamicAddresses"
																	]
																},
																{
																	"required": [
																		"ipAddressRange"
																	]
																}
															],
															"properties": {
																"macAddress": {
																	"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
																	"type": "string",
																	"format": "MAC"
																},
																"segmentationId": {
																	"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
																	"type": "string"
																},
																"ipAddresses": {
																	"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
																	"type": "array",
																	"items": {
																		"type": "object",
																		"required": [
																			"type"
																		],
																		"properties": {
																			"type": {
																				"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
																				"type": "string",
																				"enum": [
																					"IPV4",
																					"IPV6"
																				]
																			},
																			"fixedAddresses": {
																				"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
																				"type": "array",
																				"items": {
																					"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
																					"type": "string",
																					"format": "IP"
																				}
																			},
																			"numDynamicAddresses": {
																				"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
																				"type": "integer"
																			},
																			"addressRange": {
																				"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
																				"type": "object",
																				"required": [
																					"minAddress",
																					"maxAddress"
																				],
																				"properties": {
																					"minAddress": {
																						"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
																						"type": "string",
																						"format": "IP"
																					},
																					"maxAddress": {
																						"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
																						"type": "string",
																						"format": "IP"
																					}
																				}
																			},
																			"subnetId": {
																				"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
																				"type": "string"
																			}
																		}
																	}
																}
															}
														}
													}
												}
											}
										}
									}
								}
							}
						}
					},
					"extLinkPorts": {
						"description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL.\n",
						"type": "array",
						"items": {
							"description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n",
							"type": "object",
							"required": [
								"id",
								"resourceHandle"
							],
							"properties": {
								"id": {
									"description": "An identifier with the intention of being globally unique.\n",
									"type": "string"
								},
								"resourceHandle": {
									"required": [
										"resourceId"
									],
									"type": "object",
									"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
									"properties": {
										"vimConnectionId": {
											"description": "An identifier with the intention of being globally unique.\n",
											"type": "string"
										},
										"resourceProviderId": {
											"description": "An identifier with the intention of being globally unique.\n",
											"type": "string"
										},
										"resourceId": {
											"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
											"type": "string"
										},
										"vimLevelResourceType": {
											"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
											"type": "string"
										}
									}
								}
							}
						}
					}
				}
			}
		},
		"extManagedVirtualLinks": {
			"description": "Information about internal VLs that are managed by other entities than the VNFM. The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use with certain VNFs, for instance to ensure that these networks have certain properties such as security or acceleration features, or to address particular network topologies. The present document assumes that externally-managed internal VLs are managed by the NFVO and created towards the VIM. External and/or externally-managed internal VLs can be passed in VNF lifecycle management operation requests such as InstantiateVnf, ChangeVnfFlavor,  ChangeExtVnfConnectivity or ChangeCurrentVnfPackage and/or in the grant response.  The NFVO may choose to override in the grant response external and/or  externally-managed VL instances that have been passed previously in the  associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself. In case of granting an InstantiateVnf request that has originated from the NFVO  and that did not contain the \"extVirtualLinks\" attribute, this attribute shall be  set by the NFVO. Further in case of granting an InstantiateVnf request that has  originated from the NFVO and that did not contain the \"extManagedVirtualLinks\"  attribute, this attribute shall be set by the NFVO if there is the need to provide  information about externally-managed virtual links.\n",
			"type": "array",
			"items": {
				"type": "object",
				"required": [
					"id",
					"vnfVirtualLinkDescId",
					"resourceId"
				],
				"properties": {
					"id": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"vnfVirtualLinkDescId": {
						"description": "An identifier that is unique within a VNF descriptor.\n",
						"type": "string"
					},
					"vimConnectionId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceProviderId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"resourceId": {
						"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
						"type": "string"
					},
					"vnfLinkPort": {
						"description": "Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL on this network resource. If this attribute is not present, the VNFM shall create the link ports on the externally-managed VL.\n",
						"type": "array",
						"items": {
							"description": "This type represents an externally provided link port to be used to connect a VNFC connection point  to an exernally managed VL.\n",
							"type": "object",
							"required": [
								"vnfLinkPortId",
								"resourceHandle"
							],
							"properties": {
								"vnfLinkPortId": {
									"description": "An identifier with the intention of being globally unique.\n",
									"type": "string"
								},
								"resourceHandle": {
									"required": [
										"resourceId"
									],
									"type": "object",
									"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
									"properties": {
										"vimConnectionId": {
											"description": "An identifier with the intention of being globally unique.\n",
											"type": "string"
										},
										"resourceProviderId": {
											"description": "An identifier with the intention of being globally unique.\n",
											"type": "string"
										},
										"resourceId": {
											"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
											"type": "string"
										},
										"vimLevelResourceType": {
											"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
											"type": "string"
										}
									}
								}
							}
						}
					},
					"extManagedMultisiteVirtualLinkId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					}
				}
			}
		},
		"additionalParams": {
			"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
			"type": "object"
		},
		"_links": {
			"description": "Links to resources related to this resource.\n",
			"type": "object",
			"required": [
				"self",
				"vnfLcmOpOcc",
				"vnfInstance"
			],
			"properties": {
				"self": {
					"description": "This type represents a link to a resource using an absolute URI.\n",
					"type": "object",
					"required": [
						"href"
					],
					"properties": {
						"href": {
							"description": "String formatted according to IETF RFC 3986.\n",
							"type": "string"
						}
					}
				},
				"vnfLcmOpOcc": {
					"description": "This type represents a link to a resource using an absolute URI.\n",
					"type": "object",
					"required": [
						"href"
					],
					"properties": {
						"href": {
							"description": "String formatted according to IETF RFC 3986.\n",
							"type": "string"
						}
					}
				},
				"vnfInstance": {
					"description": "This type represents a link to a resource using an absolute URI.\n",
					"type": "object",
					"required": [
						"href"
					],
					"properties": {
						"href": {
							"description": "String formatted according to IETF RFC 3986.\n",
							"type": "string"
						}
					}
				}
			}
		}
	}