Skip to content
vnfInstance.schema.json 61 KiB
Newer Older
													"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"
												}
											}
										},
										"cpInstanceId": {
											"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
											"type": "string"
										},
										"cpInstanceType": {
											"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
											"type": "string",
											"enum": [
												"VNFC_CP",
												"EXT_CP"
											]
										}
									}
								}
							},
							"metadata": {
								"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"
							}
						}
					}
				},
				"vnfVirtualStorageResourceInfo": {
					"description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
					"type": "array",
					"items": {
						"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
						"type": "object",
						"required": [
							"id",
							"virtualStorageDescId",
							"storageResource"
						],
						"properties": {
							"id": {
								"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
								"type": "string"
							},
							"virtualStorageDescId": {
								"description": "An identifier that is unique within a VNF descriptor.\n",
								"type": "string"
							},
							"vnfdId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"storageResource": {
								"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"
									}
								}
							},
							"reservationId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"metadata": {
								"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"
							}
						}
					}
				},
				"vnfcInfo": {
					"description": "Information about the VNFC instances.\n",
					"type": "array",
					"items": {
						"description": "This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1.\n",
						"type": "object",
						"required": [
							"id",
							"vduId",
							"vnfcState"
						],
						"properties": {
							"id": {
								"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
								"type": "string"
							},
							"vduId": {
								"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
								"type": "string"
							},
							"vnfcResourceInfoId": {
								"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
								"type": "string"
							},
							"vnfcState": {
								"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
								"type": "string"
							},
							"vnfcConfigurableProperties": {
								"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"
							}
						}
					}
				}
			}
		},
		"metadata": {
			"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"
		},
		"extensions": {
			"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"
			],
			"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"
						}
					}
				},
				"indicators": {
					"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"
						}
					}
				},
				"instantiate": {
					"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"
						}
					}
				},
				"terminate": {
					"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"
						}
					}
				},
				"scale": {
					"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"
						}
					}
				},
				"scaleToLevel": {
					"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"
						}
					}
				},
				"changeFlavour": {
					"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"
						}
					}
				},
				"heal": {
					"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"
						}
					}
				},
				"operate": {
					"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"
						}
					}
				},
				"changeExtConn": {
					"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"
						}
					}
				},
				"createSnapshot": {
					"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"
						}
					}
				},
				"revertToSnapshot": {
					"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"
						}
					}
				}
			}
		}
	}