Skip to content
VnfSnapshotsInfo.schema.json 92.8 KiB
Newer Older
																									"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"
																								}
																							},
																							"isDynamic": {
																								"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
																								"type": "boolean"
																							},
																							"addressRange": {
																								"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present. See note 2.\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. Representation: string of variable length.\n",
																								"type": "string"
																				},
																				"type": {
																					"description": "The type of the IP addresses\n",
																					"type": "string",
																					"enum": ["PV4", "PV6"]
																				},
																				"addresses": {
																					"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"
																				},
																				"isDynamic": {
																					"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
																					"type": "boolean"
																				},
																				"addressRange": {
																					"description": "An IP address range used, e.g. in case of egress connections. See note.\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"
																						}
																				},
																				"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. Representation: string of variable length.\n",
																					"type": "string"
															},
															"parentCpId": {
																"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
																"type": "string"
															},
															"vnfLinkPortId": {
																"description": "An identifier that is unique for the respective type within a VNF instance, but may not be 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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
													"type": "object"
												}
											}
										}
									},
									"vnfVirtualLinkResourceInfo": {
										"description": "Information about the virtualised network resources used by the VLs of the VNF instance. See note 5.\n",
										"type": "array",
										"items": {
											"description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
											"type": "object",
											"required": ["id", "vnfVirtualLinkDescId", "networkResource"],
											"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"
												},
												"vnfdId": {
													"description": "An identifier with the intention of being globally unique.\n",
													"type": "string"
												},
												"vnfVirtualLinkDescId": {
													"description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
													"type": "string"
												},
												"networkResource": {
													"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. NOTE: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
													"type": "object",
													"required": ["resourceId"],
													"properties": {
														"vimId": {
															"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. Representation: string of variable length.\n",
															"type": "string"
														},
														"vimLevelResourceType": {
															"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. See note.\n",
															"type": "string"
														}
													}
												},
												"reservationId": {
													"description": "An identifier with the intention of being globally unique.\n",
													"type": "string"
												},
												"vnfLinkPorts": {
													"description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
													"type": "array",
													"items": {
														"type": "object",
														"description": "This type represents a link port of an internal VL of a VNF. It shall comply with the provisions defined in table 6.5.3.64-1.\nNOTE 1:\tEither cpInstanceId with cpInstanceType set to \"EXT_CP\" or any combination of cpInstanceId with cpInstanceType set to \"VNFC_CP\" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to \"VNFC_CP\" and vipCpInstanceId are present, the two different CP instances share the linkport.\n",
														"required": ["id", "resourceHandle"],
														"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"
															},
															"resourceHandle": {
																"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. NOTE: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
																"type": "object",
																"required": ["resourceId"],
																"properties": {
																	"vimId": {
																		"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. Representation: string of variable length.\n",
																		"type": "string"
																	},
																	"vimLevelResourceType": {
																		"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. See note.\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. See note 1.\n",
																"type": "string",
																"enum": ["VNFC_CP", "EXT_CP"]
															},
															"vipCpInstanceId": {
																"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
																"type": "string"
															},
															"trunkResourceId": {
																"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
													"type": "object"
									},
									"virtualStorageResourceInfo": {
										"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": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
													"type": "string"
												},
												"vnfdId": {
													"description": "An identifier with the intention of being globally unique.\n",
													"type": "string"
												},
												"storageResource": {
													"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. NOTE: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
													"type": "object",
													"required": ["resourceId"],
													"properties": {
														"vimId": {
															"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. Representation: string of variable length.\n",
															"type": "string"
														},
														"vimLevelResourceType": {
															"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. See note.\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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
								"type": "object"
							}
						}
					},
					"vnfcSnapshots": {
						"description": "Information about VNFC Snapshots constituting this VNF Snapshot.\n",
						"type": "array",
						"items": {
							"description": "This type represents a VNFC Snapshot. It shall comply with the provisions defined in table 6.5.3.77-1. NOTE 1:\tThe identifier of the compute snapshot resource is assigned during creation of a VNFC Snapshot being returned from the VIM as output data in the response message of the individual resource operations. This attribute shall only be present for a VNFC snapshot that has been newly created by the VNFM as a result of the \"Create VNF snapshot task\". NOTE 2:\tThe identifier of the storage snapshot resource is assigned during creation of a VNFC snapshot being returned from the VIM as output data in the response message of the individual resource operations. This attribute shall only be present for a VNFC snapshot with an associated storage resource and that has been newly created by the VNFM as a result of the \"Create VNF snapshot task\".\n",
							"type": "object",
							"required": ["id", "vnfcInstanceId", "triggeredAt", "createdAt", "vnfcInfoId"],
							"properties": {
								"id": {
									"description": "An identifier with the intention of being globally unique.\n",
									"type": "string"
								},
								"vnfcInstanceId": {
									"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
									"type": "string"
								},
								"creationStartedAt": {
									"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
									"format": "date-time"
								},
								"creationFinishedAt": {
									"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
									"format": "date-time"
								},
								"vnfcResourceInfoId": {
									"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
									"type": "string"
								},
								"computeSnapshotResource": {
									"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. NOTE: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
									"type": "object",
									"required": ["resourceId"],
									"properties": {
										"vimId": {
											"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. Representation: string of variable length.\n",
											"type": "string"
										},
										"vimLevelResourceType": {
											"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. See note.\n",
											"type": "string"
										}
									}
								"storageSnapshotResources": {
									"description": "Reference to the \"VirtualStorageResourceInfo\" structure in the \"VnfInstance\" structure that represents the virtual storage resource. See note 2.\n",
									"type": "array",
									"items": {
										"type": "object",
										"required": ["storageResourceId"],
										"properties": {
												"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
												"type": "string"
											},
											"storageSnapshotResources": {
												"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. NOTE: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
												"type": "object",
												"required": ["resourceId"],
												"properties": {
													"vimId": {
														"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. Representation: string of variable length.\n",
														"type": "string"
													},
													"vimLevelResourceType": {
														"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. See note.\n",
								},
								"userDefinedData": {
									"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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
									"type": "object"
					},
					"userDefinedData": {
						"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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\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.\n",
						"type": "object",
						"properties": {
							"href": {
								"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
								"type": "string",
								"format": "url"