Skip to content
NsLcmOpOcc.schema.json 75.8 KiB
Newer Older
	"description": "This type represents a request a NS lifecycle operation occurrence. It shall comply with the provisions defined in Table 6.5.2.3-1.\nNOTE 1:\tThis allows the OSS/BSS to obtain a copy of the latest \"result\" notification if it has not received it due to an error. If the notification represents the successful result of a lifecycle operation, at least an affectedVnf, or affectedPnf, or affectedVl, or affectedVnffg or affectedNs, or affectedSap shall be present.\nNOTE 2:\tA coordination action has timed out if the NFVO has not been able to read the \"Individual coordination action\" resource within a timeout interval after requesting the coordination to be started or to be cancelled. The length of the timeout interval is defined by means outside the scope of the present document\nNOTE 3:\tThe list of rejected coordinations may be garbage collected if the LCM operation occurrence has reached a terminal state, i.e. one of \"COMPLETED\", \"FAILED\", “PARTIALLY COMPLETED” and \"ROLLED_BACK\".\n",
	"type": "object",
	"required": ["id", "operationState", "statusEnteredTime", "nsInstanceId", "lcmOperationType", "startTime", "isAutomaticInvocation", "isCancelPending", "_links"],
	"properties": {
		"id": {
			"description": "An identifier with the intention of being globally unique.\n",
			"type": "string"
		},
		"operationState": {
			"description": "The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1. Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
			"type": "string",
			"enum": ["PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED", "ROLLING_BACK", "ROLLED_BACK"]
		},
		"stateEnteredTime": {
			"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
			"format": "date-time"
		},
		"nsInstanceId": {
			"description": "An identifier with the intention of being globally unique.\n",
			"type": "string"
		},
		"lcmOperationType": {
			"description": "The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate NS\" LCM operation. SCALE | Represents the \"Scale NS\" LCM operation. UPDATE | Represents the \"Update NS\" LCM operation. TERMINATE | Represents the \"Terminate NS\" LCM operation. HEAL | Represents the \"Heal NS\" LCM operation.\n",
			"type": "string",
			"enum": ["INSTANTIATE", "SCALE", "UPDATE", "TERMINATE", "HEAL"]
		},
		"startTime": {
			"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
			"format": "date-time"
		},
		"isAutomaticInvocation": {
			"description": "Set to true if this NS LCM operation occurrence has been automatically triggered by the NFVO. This occurs in the case of auto-scaling, auto-healing and when a nested NS is modified as a result of an operation on its composite NS. Set to false otherwise.\n",
			"type": "boolean"
		},
		"operationParams": {
			"description": "Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. In addition, the provisions in clause 6.7 shall apply. The following mapping between lcmOperationType and the data type of this attribute shall apply: - INSTANTIATE: InstantiateNsRequest - SCALE: ScaleNsRequest - UPDATE: UpdateNsRequest - HEAL: HealNsRequest - TERMINATE: TerminateNsRequest This attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n",
			"type": "string",
			"enum": ["INSTANTIATE", "SCALE", "UPDATE", "HEAL", "TERMINATE"]
		},
		"isCancelPending": {
			"description": "If the LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.\n",
			"type": "boolean"
		},
		"cancelMode": {
			"description": "Cancellation mode.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\n",
			"type": "string",
			"enum": ["GRACEFUL", "FORCEFUL"]
		},
		"error": {
			"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
			"type": "object",
			"required": ["status", "detail"],
			"properties": {
				"type": {
					"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
					"type": "string",
					"format": "URI"
				},
				"title": {
					"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
					"type": "string"
				},
				"status": {
					"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
					"type": "integer"
				},
				"detail": {
					"description": "A human-readable explanation specific to this occurrence of the problem.\n",
					"type": "string"
				},
				"instance": {
					"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
					"type": "string",
					"format": "URI"
				}
			}
		},
		"resourceChanges": {
			"description": "This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable\n",
			"type": "object",
			"properties": {
				"affectedVnfs": {
					"description": "Information about the VNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note 1.\n",
					"type": "array",
					"items": {
						"description": "This type provides information about added, deleted and modified VNFs.\nNOTE:\tAt least one of the attributes \"changedVnfInfo\", \"changedExtConnectivity\" or \"modificationsTriggeredByVnfPkgChange\" shall be present. Not more than one of \"changedVnfInfo\" and \"modificationsTriggeredByVnfPkgChange\" shall be present.\n",
						"type": "object",
						"required": ["vnfInstanceId", "vnfdId", "vnfProfileId", "vnfName", "changeType", "changeResult"],
						"anyOf": [{
							"required": ["changedExtConnectivity"]
						}, {
							"oneOf": [{
								"required": ["changedVnfInfo"]
							}, {
								"required": ["modificationsTriggeredByVnfPkgChange"]
							}]
						}],
						"properties": {
							"vnfInstanceId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"vnfdId": {
								"description": "An identifier with the intention of being globally unique.\n",
								"type": "string"
							},
							"vnfProfileId": {
								"description": "An identifier that is unique within a NS descriptor. Representation: string of variable length.\n",
								"type": "string"
							},
							"vnfName": {
								"description": "Name of the VNF Instance.\n",
								"type": "string"
							},
							"changeType": {
								"description": "Signals the type of change Permitted values: - ADD - REMOVE - INSTANTIATE - TERMINATE - SCALE - CHANGE_FLAVOUR - HEAL - OPERATE - MODIFY_INFORMATION - CHANGE_EXTERNAL_VNF_CONNECTIVITY -\tCHANGE_VNFPKG\n",
								"type": "string",
								"enum": ["ADD", "REMOVE", "INSTANTIATE", "TERMINATE", "SCALE", "CHANGE_FLAVOUR", "HEAL", "OPERATE", "MODIFY_INFORMATION", "CHANGE_EXTERNAL_VNF_CONNECTIVITY", "CHANGE_VNFPKG"]
							},
							"changeResult": {
								"description": "Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n",
								"type": "string",
								"enum": ["COMPLETED", "ROLLED_BACK", "FAILED"]
							},
							"changedInfo": {
								"description": "Information about the changed VNF instance information, including VNF configurable properties,if applicable. When the \"changedInfo\" attribute is present,  either the \"changedVnfInfo\" attribute or the \"changedExtConnectivity\" attribute or both shall be present.\n",
								"type": "object",
								"anyOf": [{
									"required": ["changedVnfInfo"]
								}, {
									"required": ["changedVnfInfo"]
								}, {
									"required": ["modificationsTriggeredByVnfPkgChange"]
								}],
								"oneOf": [{
									"required": ["changedVnfInfo"]
								}, {
									"required": ["modificationsTriggeredByVnfPkgChange"]
								}],
								"properties": {
									"changedVnfInfo": {
										"description": "This type represents the information that is requested to be modified for a VNF instance. The information to be modified shall comply with the associated NSD. EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.\n",
										"type": "object",
										"required": ["vnfInstanceId"],
										"properties": {
											"vnfInstanceId": {
												"description": "An identifier with the intention of being globally unique.\n",
												"type": "string"
											},
											"vnfInstanceName": {
												"description": "New value of the \"vnfInstanceName\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n",
												"type": "string"
											},
											"vnfInstanceDescription": {
												"description": "New value of the \"vnfInstanceDescription\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n",
												"type": "string"
											},
											"vnfdId": {
												"description": "An identifier with the intention of being globally unique.\n",
												"type": "string"
											},
											"vnfConfigurableProperties": {
												"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"
											}
										}
									},
									"changedExtConnectivity": {
										"description": "Information about changed external connectivity, if applicable. Only information about external VL instances that have been added or modified shall be provided. See note.\n",
										"type": "array",
										"items": {
											"type": "object",
											"required": ["id", "resourceHandle"],
											"properties": {
												"id": {
													"description": "An identifier with the intention of being 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"
														},
Loading
Loading full blame…