From 6d020cb64ef67db955d0d490d234260edb5c13c7 Mon Sep 17 00:00:00 2001 From: moscatelli Date: Fri, 12 Jul 2019 12:59:21 +0200 Subject: [PATCH] SOL003/SOl002: VNF Lifecycle management datatypes consolidation --- .../VNFLifecycleManagement.yaml | 2 +- .../SOL002VNFLifecycleManagement_def.yaml | 151 +++- .../VNFLifecycleManagement.yaml | 74 +- ... => SOL003VNFLifecycleManagement_def.yaml} | 837 ++++++++++-------- .../VNFLifecycleManagement_resp.yaml | 183 ---- ...FLifecycleManagementNotification_def.yaml} | 0 src/SOL003/definitions/SOL003_def.yaml | 58 +- ...OL002SOL003VNFLifecycleManagement_def.yaml | 493 ++--------- 8 files changed, 744 insertions(+), 1054 deletions(-) rename src/SOL003/VNFLifecycleManagement/definitions/{VNFLifecycleManagement_def.yaml => SOL003VNFLifecycleManagement_def.yaml} (50%) delete mode 100644 src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml rename src/SOL003/VNFLifecycleManagementNotification/definitions/{VNFLifecycleManagementNotification_def.yaml => SOL003VNFLifecycleManagementNotification_def.yaml} (100%) diff --git a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 493549c9..27c3569c 100644 --- a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -551,7 +551,7 @@ paths: in: body required: true schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest" + $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest" responses: 202: description: > diff --git a/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml b/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml index 85fba009..5a493a9f 100644 --- a/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml +++ b/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml @@ -227,27 +227,50 @@ definitions: instance resource (i.e. VNF instance is in INSTANTIATED state). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - ChangeExtVnfConnectivityRequest: - description: > - This type represents request parameters for the - "Change external VNF connectivity" operation to modify the external - connectivity of a VNF instance. + InstantiateVnfRequest: type: object required: - - extVirtualLinks + - flavourId properties: + flavourId: + description: > + Identifier of the VNF deployment flavour to be instantiated. + $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + instantiationLevelId: + description: > + Identifier of the instantiation level of the deployment flavour to be + instantiated. If not present, the default instantiation level as + declared in the VNFD is instantiated. + $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" extVirtualLinks: description: > - Information about external VLs to change (e.g. connect the VNF to). + Information about external VLs to connect the VNF to. type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + $ref: "SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + extManagedVirtualLinks: + description: > + Information about external VLs to connect the VNF to. + type: array + items: + $ref: "SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData" + localizationLanguage: + description: > + Localization language of the VNF to be instantiated. The value shall + comply with the format defined in IETF RFC 5646. + type: string additionalParams: description: > Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of - "ChangeExtVnfConnectivityOpConfig".". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + to the VNF being instantiated, as declared in the VNFD as part of + "InstantiateVnfOpConfig". + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + If present, this attribute provides values for the "extensions" attribute in "VnfInstance", + as defined in clause 5.5.2.2. If an entry with the same key exists in the VnfInstance data structure, + the VNFM shall replace its value with the value passed in the InstantiateVnfRequest data structure. + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" ChangeVnfFlavourRequest: description: > @@ -281,10 +304,31 @@ definitions: additionalParams: description: > Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of + to the VNF being instantiated, as declared in the VNFD as part of "InstantiateVnfOpConfig". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + TerminateVnfRequest: + type: object + required: + - terminationType + properties: + terminationType: + description: > + Indicates the type of termination is requested. + Permitted values: + * FORCEFUL: The VNFM will shut down the VNF and release the + resources immediately after accepting the request. + type: string + enum: + - FORCEFUL + additionalParams: + description: > + Additional parameters passed by the NFVO as input to the termination + process, specific to the VNF being terminated, as declared in the + VNFD as part of "TerminateVnfOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + HealVnfRequest: type: object properties: @@ -345,23 +389,78 @@ definitions: declared in the VNFD as part of "OperateVnfOpConfig". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - TerminateVnfRequest: + ChangeExtVnfConnectivityRequest: + description: > + This type represents request parameters for the + "Change external VNF connectivity" operation to modify the external + connectivity of a VNF instance. type: object required: - - terminationType + - extVirtualLinks properties: - terminationType: + extVirtualLinks: description: > - Indicates the type of termination is requested. - Permitted values: - * FORCEFUL: The VNFM will shut down the VNF and release the - resources immediately after accepting the request. - type: string - enum: - - FORCEFUL + Information about external VLs to change (e.g. connect the VNF to). + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" additionalParams: description: > - Additional parameters passed by the NFVO as input to the termination - process, specific to the VNF being terminated, as declared in the - VNFD as part of "TerminateVnfOpConfig". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" \ No newline at end of file + Additional input parameters for the instantiation process, specific + to the VNF being instantiated, as declared in the VNFD as part of + "ChangeExtVnfConnectivityOpConfig".". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfInfoModificationRequest: + description: > + This type represents attribute modifications for an "Individual VNF instance" resource, + i.e. modifications to a resource representation based on the "VnfInstance" data type. + The attributes of "VnfInstance" that can be modified according to the provisions in clause 5.5.2.2 + are included in the "VnfInfoModificationRequest" data type. + The "VnfInfoModificationRequest" data type shall comply with the provisions defined in table 5.5.2.12-1. + type: object + properties: + vnfInstanceName: + description: > + New value of the "vnfInstanceName" attribute in "VnfInstance", or "null" to remove the attribute. + type: string + vnfInstanceDescription: + description: > + New value of the "vnfInstanceDescription" attribute in "VnfInstance", or "null" to remove the attribute. + type: string + vnfdId: + description: > + New value of the "vnfdId" attribute in "VnfInstance". The value "null" is not permitted. + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" + vnfConfigurableProperties: + description: > + Modifications of the "vnfConfigurableProperties" attribute in "VnfInstance". + If present, these modifications shall be applied according to the rules of + JSON Merge PATCH (see IETF RFC 7396 [15]). + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + metadata: + description: > + Modifications of the "metadattametadata" attribute in "VnfInstance". + If present, these modifications shall be applied according to the rules of + JSON Merge PATCH (see IETF RFC 7396 [15]). + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + Modifications of the "extensions" attribute in "VnfInstance". + If present, these modifications shall be applied according to the rules of + JSON Merge PATCH (see IETF RFC 7396 [15]). + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vnfcInfoModifications: + description: > + Modifications of certain entries in the "vnfcInfo" attribute array in the + "instantiatedVnfInfo" attribute of "VnfInstance"." to be used as "newList" as defined below this table. + type: array + items: + $ref: "#/definitions/VnfcInfoModifications" + vnfcInfoModificationsDeleteIds: + description: > + List of identifiers entries to be deleted from the 'vnfcInfoModifications" attribute array + to be used as "deleteIdList" as defined below this table. + type: array + items: + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" \ No newline at end of file diff --git a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 13a4c45b..25e26731 100644 --- a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -133,7 +133,7 @@ paths: maximum: 1 minimum: 1 schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -278,7 +278,7 @@ paths: schema: type: array items: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -380,7 +380,7 @@ paths: maximum: 1 minimum: 1 schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -423,7 +423,7 @@ paths: required: true in: body schema: - $ref: "../definitions/SOL003_def.yaml#/definitions/VnfInfoModificationRequest" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest" - name: Authorization description: > The authorization token for the request. @@ -438,7 +438,8 @@ paths: in: header required: true type: string - enum: ["application/merge-patch+json"] + enum: + - application/merge-patch+json - name: Version description: > Version of the API requested to use when responding to this request. @@ -476,7 +477,7 @@ paths: maximum: 1 minimum: 0 schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -491,6 +492,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the "Individual VNF instance" resource. Typically, this is due to the fact that another LCM operation is ongoing. @@ -564,6 +567,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state. @@ -609,7 +614,7 @@ paths: in: body required: true schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest" - name: Accept description: > Content-Types that are acceptable for the response. @@ -682,6 +687,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state, @@ -798,6 +805,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 404: description: > + 404 NOT FOUND + Shall be returned upon the following error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, @@ -812,6 +821,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the "Individual VNF instance" resource is in @@ -927,6 +938,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 404: description: > + 404 NOT FOUND + Shall be returned upon the following error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, @@ -941,6 +954,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state, @@ -989,7 +1004,7 @@ paths: in: body required: true schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest" - name: Accept description: > Content-Types that are acceptable for the response. @@ -1056,6 +1071,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 404: description: > + 404 NOT FOUND + Shall be returned upon the following error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, @@ -1117,7 +1134,7 @@ paths: in: body required: true schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest" - name: Accept description: > Content-Types that are acceptable for the response. @@ -1190,6 +1207,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state, @@ -1234,7 +1253,7 @@ paths: in: body required: true schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest" - name: Accept description: > Content-Types that are acceptable for the response. @@ -1301,6 +1320,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 404: description: > + 404 NOT FOUND + Shall be returned upon the following error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, @@ -1315,6 +1336,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state, @@ -1362,7 +1385,7 @@ paths: in: body required: true schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest" - name: Accept description: > Content-Types that are acceptable for the response. @@ -1429,6 +1452,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 404: description: > + 404 NOT FOUND + Shall be returned upon the following error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, @@ -1443,6 +1468,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state, @@ -1489,7 +1516,7 @@ paths: in: body required: true schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest" + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest" - name: Accept description: > Content-Types that are acceptable for the response. @@ -1562,6 +1589,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that another lifecycle management operation is ongoing, @@ -1705,7 +1734,7 @@ paths: maximum: 1 minimum: 0 schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -1799,7 +1828,7 @@ paths: maximum: 1 minimum: 1 schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -1890,6 +1919,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 404: description: > + 404 NOT FOUND + Shall be returned upon the following error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, @@ -1904,6 +1935,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the VNF LCM operation occurrence. Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state, @@ -1987,6 +2020,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 404: description: > + 404 NOT FOUND + Shall be returned upon the following error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, @@ -2001,6 +2036,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the VNF LCM operation occurrence. Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state, @@ -2090,7 +2127,7 @@ paths: maximum: 1 minimum: 1 schema: - $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -2099,6 +2136,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 404: description: > + 404 NOT FOUND + Shall be returned upon the following error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, @@ -2113,6 +2152,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the VNF LCM operation occurrence. Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state, @@ -2217,6 +2258,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the VNF LCM operation occurrence. Typically, this is due to the fact that the operation occurrence is not in STARTING, @@ -2545,6 +2588,7 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + delete: description: > Terminate Subscription. diff --git a/src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml b/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml similarity index 50% rename from src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml rename to src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml index 5e4c1274..fcae23d5 100644 --- a/src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml +++ b/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml @@ -2,94 +2,305 @@ # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: - CancelMode: + VnfInstance: description: > - This type represents a parameter to select the mode of cancelling an - ongoing VNF LCM operation occurrence. + This type represents a VNF instance. type: object required: - - cancelMode + - id + - vnfdId + - vnfProvider + - vnfProductName + - vnfSoftwareVersion + - vnfdVersion + - instantiationState properties: - cancelMode: + id: description: > - Cancellation mode to apply. - $ref: "#/definitions/CancelModeType" - - CancelModeType: - description: > - Cancellation mode. - GRACEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or - "ROLLING_BACK" state, the VNFM shall not start any new resource - management operation and shall wait for the ongoing resource management - operations in the underlying system, typically the VIM, to finish - execution or to time out. After that, the VNFM shall put the operation - occurrence into the FAILED_TEMP state. - If the VNF LCM operation occurrence is in "STARTING" state, the VNFM - shall not start any resource management operation and shall wait for - the granting request to finish execution or time out. After that, the - VNFM shall put the operation occurrence into the ROLLED_BACK state. - FORCEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or - "ROLLING_BACK" state, the VNFM shall not start any new resource - management operation, shall cancel the ongoing resource management - operations in the underlying system, typically the VIM, and shall wait - for the cancellation to finish or to time out. After that, the VNFM - shall put the operation occurrence into the FAILED_TEMP state. - If the VNF LCM operation occurrence is in "STARTING" state, the VNFM - shall not start any resource management operation and put the operation - occurrence into the ROLLED_BACK state. - type: string - enum: - - GRACEFUL - - FORCEFUL - - ChangeExtVnfConnectivityRequest: - #SOL003 location: 5.5.2.11 - description: > - This type represents request parameters for the - "Change external VNF connectivity" operation to modify the external - connectivity of a VNF instance. - type: object - required: - - extVirtualLinks - properties: - extVirtualLinks: + Identifier of the VNF instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfInstanceName: description: > - Information about external VLs to change (e.g. connect the VNF to). - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + Name of the VNF instance. + This attribute can be modified with the PATCH method. + type: string + vnfInstanceDescription: + description: > + Human-readable description of the VNF instance. + This attribute can be modified with the PATCH method. + type: string + vnfdId: + description: > + Identifier of the VNFD on which the VNF instance is based. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfProvider: + description: > + Provider of the VNF and the VNFD. The value is copied from the VNFD. + type: string + vnfProductName: + description: > + Name to identify the VNF Product. The value is copied from the VNFD. + type: string + vnfSoftwareVersion: + description: > + Software version of the VNF. The value is copied from the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" + vnfdVersion: + description: > + Identifies the version of the VNFD. The value is copied from the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" + vnfConfigurableProperties: + description: > + Current values of the configurable properties of the VNF instance. + Configurable properties referred in this attribute are declared in + the VNFD. + ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD + based on TOSCA specifications. + VNF configurable properties are sometimes also referred to as + configuration parameters applicable to a VNF. Some of these are set + prior to instantiation and cannot be modified if the VNF is + instantiated, some are set prior to instantiation (are part of + initial configuration) and can be modified later, and others can be + set only after instantiation. The applicability of certain + configuration may depend on the VNF and the required operation of + the VNF at a certain point in time. + These configurable properties include the following standard + attributes, which are declared in the VNFD if auto-scaling and/or + auto-healing are supported by the VNF: + * isAutoscaleEnabled: If present, the VNF supports auto-scaling. If + set to true, auto-scaling is currently enabled. If set to false, + auto-scaling is currently disabled. + * isAutohealEnabled: If present, the VNF supports auto-healing. If + set to true, auto-healing is currently enabled. If set to false, + auto-healing is currently disabled. + This attribute can be modified with the PATCH method. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vimConnectionInfo: description: > Information about VIM connections to be used for managing the - resources for the VNF instance, or refer to external virtual - links. This attribute shall only be supported and may be present - if VNF-related resource management in direct mode is applicable. + resources for the VNF instance. This attribute shall only be + supported and present if VNF-related resource management in direct + mode is applicable. + This attribute can be modified with the PATCH method. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - additionalParams: + instantiationState: description: > - Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of - "ChangeExtVnfConnectivityOpConfig".". + The instantiation state of the VNF. + type: string + enum: + - NOT_INSTANTIATED + - INSTANTIATED + instantiatedVnfInfo: + description: > + Information specific to an instantiated VNF instance. This attribute + shall be present if the instantiateState attribute value is + INSTANTIATED. + type: object + required: + - flavourId + - vnfState + properties: + flavourId: + description: > + Identifier of the VNF deployment flavour applied to this VNF instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfState: + description: > + The state of the VNF instance. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType" + scaleStatus: + description: > + Scale status of the VNF, one entry per aspect. + Represents for every scaling aspect how "big" the VNF has been scaled w.r.t. that aspect. + This attribute shall be present if the VNF supports scaling. + See clause B.2 for an explanation of VNF scaling. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo" + extCpInfo: + description: > + Information about the external CPs exposed by the VNF instance. + type: array + minItems: 1 + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfExtCpInfo" + extVirtualLinkInfo: + description: > + Information about the external VLs the VNF instance is connected to. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" + extManagedVirtualLinkInfo: + description: > + External virtual links the VNF instance is connected to. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkInfo" + monitoringParameters: + description: > + Active monitoring parameters. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/MonitoringParameter" + localizationLanguage: + description: > + Information about localization language of the VNF (includes e.g. + strings in the VNFD). The localization languages supported by a VNF + can be declared in the VNFD, and localization language selection can + take place at instantiation time. + The value shall comply with the format defined in IETF RFC 5646. + type: string + vnfcResourceInfo: + description: > + Information about the virtualised compute and storage resources used + by the VNFCs of the VNF instance. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcResourceInfo" + virtualLinkResourceInfo: + description: > + Information about the virtualised network resources used by the VLs + of the VNF instance. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfVirtualLinkResourceInfo" + virtualStorageResourceInfo: + description: > + Information on the virtualised storage resource(s) used as storage for the VNF instance. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VirtualStorageResourceInfo" + metadata: + description: > + Additional VNF-specific attributes that provide metadata describing the VNF instance. + These attributes represent values that are stored persistently in the VnfInstance structure + for consumption by functional blocks that invoke the VNF lifecycle management interface. + They are not consumed by the VNFM, or the lifecycle management scripts. + Modifying the values of these attributes has no effect on the VNF instance, it only affects + the information represented in the VnfInstance structure. + Metadata that are writeable are the VNF provider foresees are expected to be declared in the VNFD. + The declaration of metadata in the VNFD can optionally contain the specification of initial values. + The VNFM shall accept requests to write metadata that are not declared in the VNFD. + These attributes can be initialized with default values from the VNFD or with values + passed in the CreateVnfRequest structure (see clause 5.5.2.3). + This attributeThese attributes can be created, modified or removed with the PATCH method. + + ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. + Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes + of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with + a defined initial value. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions" + that have no declared initial value shall not be created, in order to be consistent with the semantics + of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + Additional VNF-specific attributes that affect the lifecycle management of this VNF instance. + These attributes represent values that are stored persistently in the VnfInstance structure + for consumption by the VNFM or the lifecycle management scripts during the execution of + VNF lifecycle management operations. + All extensions that are allowed for the VNF are declared in the VNFD. The declaration of an extension + in the VNFD contains information on whether its presence is optional or required, and optionally + can specify an initial value. See note 2 and note 4. The VNFM shall reject requests to write extension + attributes that are not declared in the VNFD with a "422 Unprocessable entity" error response as defined + in clause 6.4 of ETSI GS NFV-SOL 013. + Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified + attribute values can be considered during subsequent VNF lifecycle management operations, which means that + the modified values can indirectly affect the configuration of the VNF instance. + These attributes can be initialized with default values from the VNFD or with values passed in the + InstantiateVnfRequest structure (see clause 5.5.2.4). + Attributes initialized with default values from the VNFD can be updated with values passed in the + InstantiateVnfRequest structure. + Further, these attributes can be created, modified or deleted with the PATCH method. - ChangeVnfFlavourRequest: - #SOL003 location: 5.5.2.7 - description: > - This type represents request parameters for the "Change VNF flavour" operation. + Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes + of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with + a defined initial value. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions" + that have no declared initial value shall not be created, in order to be consistent with the semantics + of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + _links: + description: > + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + description: URI of this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + indicators: + description: Indicators related to this VNF instance, if applicable. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + instantiate: + description: > + Link to the "Instantiate VNF task" resource, if the related operation + is possible based on the current status of this VNF instance + resource (i.e. VNF instance in NOT_INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + terminate: + description: > + Link to the "Terminate VNF task" resource, if the related operation + is possible based on the current status of this VNF instance + resource (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + scale: + description: > + Link to the "Scale VNF task" resource, if the related operation is + supported for this VNF instance, and is possible based on the + current status of this VNF instance resource (i.e. VNF instance + is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + scaleToLevel: + description: > + Link to the "Scale VNF to level task" resource, if the related + operation is supported for this VNF instance, and is possible + based on the current status of this VNF instance resource + (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + changeFlavour: + description: > + Link to the "Change VNF flavour task" resource, if the related + operation is supported for this VNF instance, and is possible + based on the current status of this VNF instance resource + (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + heal: + description: > + Link to the "Heal VNF task" resource, if the related operation is + supported for this VNF instance, and is possible based on the + current status of this VNF instance resource + (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + operate: + description: > + Link to the "Operate VNF task" resource, if the related operation is + supported for this VNF instance, and is possible based on the + current status of this VNF instance resource + (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + changeExtConn: + description: > + Link to the "Change external VNF connectivity task" resource, if the related + operation is possible based on the current status of this VNF + instance resource (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + + InstantiateVnfRequest: + #SOL003 location: 5.5.2.4 type: object required: - - newFlavourId + - flavourId properties: - newFlavourId: + flavourId: description: > Identifier of the VNF deployment flavour to be instantiated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" instantiationLevelId: description: > - Identifier of the instantiation level of the deployment flavour to - be instantiated. If not present, the default instantiation level as + Identifier of the instantiation level of the deployment flavour to be + instantiated. If not present, the default instantiation level as declared in the VNFD is instantiated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" extVirtualLinks: @@ -114,41 +325,34 @@ definitions: type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - additionalParams: - description: > - Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of - "InstantiateVnfOpConfig". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - - HealVnfRequest: - type: object - properties: - cause: + localizationLanguage: description: > - Indicates the reason why a healing procedure is required. + Localization language of the VNF to be instantiated. The value shall + comply with the format defined in IETF RFC 5646. type: string additionalParams: description: > - Additional parameters passed by the NFVO as input to the healing - process, specific to the VNF being healed, as declared in the VNFD - as part of "HealVnfOpConfig". + Additional input parameters for the instantiation process, specific + to the VNF being instantiated, as declared in the VNFD as part of + "InstantiateVnfOpConfig". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - InstantiateVnfRequest: - #SOL003 location: 5.5.2.4 + ChangeVnfFlavourRequest: + #SOL003 location: 5.5.2.7 + description: > + This type represents request parameters for the "Change VNF flavour" operation. type: object required: - - flavourId + - newFlavourId properties: - flavourId: + newFlavourId: description: > Identifier of the VNF deployment flavour to be instantiated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" instantiationLevelId: description: > - Identifier of the instantiation level of the deployment flavour to be - instantiated. If not present, the default instantiation level as + Identifier of the instantiation level of the deployment flavour to + be instantiated. If not present, the default instantiation level as declared in the VNFD is instantiated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" extVirtualLinks: @@ -173,38 +377,65 @@ definitions: type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - localizationLanguage: - description: > - Localization language of the VNF to be instantiated. The value shall - comply with the format defined in IETF RFC 5646. - type: string additionalParams: description: > Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of + to the VNF being instantiated, as declared in the VNFD as part of "InstantiateVnfOpConfig". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - LcmOperationStateType: - description: > - Value | Description - ------|------------ - STARTING | The LCM operation is starting. - PROCESSING | The LCM operation is currently in execution. - COMPLETED | he LCM operation has been completed successfully. - 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. - ROLLING_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. - type: string - enum: - - STARTING - - PROCESSING - - COMPLETED - - FAILED_TEMP - - FAILED - - ROLLING_BACK - - ROLLED_BACK + TerminateVnfRequest: + type: object + required: + - terminationType + properties: + terminationType: + description: > + Indicates whether forceful or graceful termination is requested. + Permitted values: + * FORCEFUL: The VNFM will shut down the VNF and release the + resources immediately after accepting the request. + * GRACEFUL: The VNFM will first arrange to take the VNF out of + service after accepting the request. Once the operation of taking + the VNF out of service finishes (irrespective of whether it has + succeeded or failed) or once the timer value specified in the + "gracefulTerminationTimeout" attribute expires, the VNFM will shut + down the VNF and release the resources. + type: string + enum: + - FORCEFUL + - GRACEFUL + gracefulTerminationTimeout: + description: > + This attribute is only applicable in case of graceful termination. + It defines the time to wait for the VNF to be taken out of service + before shutting down the VNF and releasing the resources. + The unit is seconds. + If not given and the "terminationType" attribute is set to + "GRACEFUL", it is expected that the VNFM waits for the successful + taking out of service of the VNF, no matter how long it takes, + before shutting down the VNF and releasing the resources. + type: integer + additionalParams: + description: > + Additional parameters passed by the NFVO as input to the termination + process, specific to the VNF being terminated, as declared in the + VNFD as part of "TerminateVnfOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + HealVnfRequest: + type: object + properties: + cause: + description: > + Indicates the reason why a healing procedure is required. + type: string + additionalParams: + description: > + Additional parameters passed by the NFVO as input to the healing + process, specific to the VNF being healed, as declared in the VNFD + as part of "HealVnfOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" OperateVnfRequest: description: > @@ -254,274 +485,164 @@ definitions: declared in the VNFD as part of "OperateVnfOpConfig". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - ScaleVnfToLevelRequest: + VnfInfoModificationRequest: description: > - This type represents request parameters for the "Scale VNF to Level" - operation. + This type represents attribute modifications for an + "Individual VNF instance" resource, i.e. modifications to a resource + representation based on the "VnfInstance" data type. type: object properties: - instantiationLevelId: + vnfInstanceName: + description: > + New value of the "vnfInstanceName" attribute in "VnfInstance", or + "null" to remove the attribute. + type: string + vnfInstanceDescription: + description: > + New value of the "vnfInstanceDescription" attribute in + "VnfInstance", or "null" to remove the attribute. + type: string + vnfPkgId: + description: > + New value of the "vnfPkgId" attribute in "VnfInstance". + The value "null" is not permitted. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfConfigurableProperties: + description: > + Modifications of the "vnfConfigurableProperties" attribute in + "VnfInstance". If present, these modifications shall be applied + according to the rules of JSON Merge PATCH (see IETF RFC 7396). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + metadata: + description: > + Modifications of the "metadata" attribute in "VnfInstance". If + present, these modifications shall be applied according to the rules + of JSON Merge PATCH (see IETF RFC 7396). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + Modifications of the "extensions" attribute in "VnfInstance". If + present, these modifications shall be applied according to the rules + of JSON Merge PATCH (see IETF RFC 7396). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vimConnectionInfo: description: > - Identifier of the target instantiation level of the current - deployment flavour to which the VNF is requested to be scaled. - Either the instantiationLevelId attribute or the scaleInfo attribute - shall be included. - $ref: "#/definitions/IdentifierInVnfd" - scaleInfo: - description: > - For each scaling aspect of the current deployment flavour, indicates - the target scale level to which the VNF is to be scaled. - Either the instantiationLevelId attribute or the scaleInfo attribute - shall be included. + New content of certain entries in the "vimConnectionInfo" attribute + array in "VnfInstance", as defined below this table. type: array items: - $ref: "#/definitions/ScaleInfo" - additionalParams: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" + vimConnectionInfoDeleteIds: description: > - Additional parameters passed by the NFVO as input to the scaling - process, specific to the VNF being scaled, as declared in the - VNFD as part of "ScaleVnfToLevelOpConfig". - $ref: "#/definitions/KeyValuePairs" + List of identifiers entries to be deleted from the "vimConnectionInfo" + attribute array in "VnfInstance", to be used as "deleteIdList" as defined + below this table. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - StopType: + ChangeExtVnfConnectivityRequest: + #SOL003 location: 5.5.2.11 description: > - * FORCEFUL: The VNFM will stop the VNF immediately after accepting the - request. - * GRACEFUL: The VNFM will first arrange to take the VNF out of service - after accepting the request. Once that operation is successful or once - the timer value specified in the "gracefulStopTimeout" attribute - expires, the VNFM will stop the VNF. - type: string - enum: - - FORCEFUL - - GRACEFUL - - TerminateVnfRequest: + This type represents request parameters for the + "Change external VNF connectivity" operation to modify the external + connectivity of a VNF instance. type: object required: - - terminationType + - extVirtualLinks properties: - terminationType: + extVirtualLinks: description: > - Indicates whether forceful or graceful termination is requested. - Permitted values: - * FORCEFUL: The VNFM will shut down the VNF and release the - resources immediately after accepting the request. - * GRACEFUL: The VNFM will first arrange to take the VNF out of - service after accepting the request. Once the operation of taking - the VNF out of service finishes (irrespective of whether it has - succeeded or failed) or once the timer value specified in the - "gracefulTerminationTimeout" attribute expires, the VNFM will shut - down the VNF and release the resources. - type: string - enum: - - FORCEFUL - - GRACEFUL - gracefulTerminationTimeout: + Information about external VLs to change (e.g. connect the VNF to). + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + vimConnectionInfo: description: > - This attribute is only applicable in case of graceful termination. - It defines the time to wait for the VNF to be taken out of service - before shutting down the VNF and releasing the resources. - The unit is seconds. - If not given and the "terminationType" attribute is set to - "GRACEFUL", it is expected that the VNFM waits for the successful - taking out of service of the VNF, no matter how long it takes, - before shutting down the VNF and releasing the resources. - type: integer + Information about VIM connections to be used for managing the + resources for the VNF instance, or refer to external virtual + links. This attribute shall only be supported and may be present + if VNF-related resource management in direct mode is applicable. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" additionalParams: description: > - Additional parameters passed by the NFVO as input to the termination - process, specific to the VNF being terminated, as declared in the - VNFD as part of "TerminateVnfOpConfig". + Additional input parameters for the instantiation process, specific + to the VNF being instantiated, as declared in the VNFD as part of + "ChangeExtVnfConnectivityOpConfig".". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - VnfLcmOpOcc: + CancelMode: description: > - This type represents a VNF lifecycle management operation occurrence. + This type represents a parameter to select the mode of cancelling an + ongoing VNF LCM operation occurrence. type: object required: - - id - - operationState - - stateEnteredTime - - startTime - - vnfInstanceId - - operation - - isAutomaticInvocation - - isCancelPending + - cancelMode properties: - id: - description: > - Identifier of this VNF lifecycle management operation occurrence. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - operationState: - description: > - The state of the LCM operation. - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType" - stateEnteredTime: - description: > - Date-time when the current state was entered. - type: string - format: date-time - startTime: - description: > - Date-time of the start of the operation. - type: string - format: date-time - vnfInstanceId: - description: > - Identifier of the VNF instance to which the operation applies - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - grantId: - description: > - Identifier of the grant related to this VNF LCM operation - occurrence, if such grant exists. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - operation: - description: > - Type of the actual LCM operation represented by this VNF LCM - operation occurrence. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmOperationType" - isAutomaticInvocation: - description: > - Set to true if this VNF LCM operation occurrence has been triggered - by an automated procedure inside the VNFM (i.e. - ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf - triggered by auto-heal). Set to false otherwise. - 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. The following mapping between operationType and the - data type of this attribute shall apply: - * INSTANTIATE: InstantiateVnfRequest - * SCALE: ScaleVnfRequest - * SCALE_TO_LEVEL: ScaleVnfToLevelRequest - * CHANGE_FLAVOUR: ChangeVnfFlavourRequest - * OPERATE: OperateVnfRequest - * HEAL: HealVnfRequest - * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest - * TERMINATE: TerminateVnfRequest - * MODIFY_INFO: VnfInfoModificationRequest - 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. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - isCancelPending: - description: > - If the VNF LCM operation occurrence is in "STARTING", "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. - type: boolean cancelMode: description: > - The mode of an ongoing cancellation. Shall be present when - isCancelPending=true, and shall be absent otherwise. + Cancellation mode to apply. $ref: "#/definitions/CancelModeType" - error: - description: > - If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState" - is "PROCESSING" or "ROLLING_BACK" and previous value of - "operationState" was "FAILED_TEMP", this attribute shall be present - and contain error information, unless it has been requested to be - excluded via an attribute selector. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - 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. - type: object - properties: - affectedVnfcs: - description: > - Information about VNFC instances that were affected during the - lifecycle operation. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/AffectedVnfc" - affectedVirtualLinks: - description: > - Information about VL instances that were affected during the - lifecycle operation. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - type: array - items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualLink" - affectedVirtualStorages: - description: > - Information about virtualised storage instances that were affected - during the lifecycle operation. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - type: array - items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualStorage" - changedInfo: - description: > - Information about the changed VNF instance information, including - VNF configurable properties, if applicable. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications" - changedExtConnectivity: - description: > - Information about changed external connectivity, if applicable. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - type: array - items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" - _links: - description: > - Links to resources related to this resource. - type: object - required: - - self - - vnfInstance - properties: - self: - description: > - URI of this resource. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - vnfInstance: - description: > - Link to the VNF instance that the operation applies to. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - grant: - description: > - Link to the grant for this operation, if one exists. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - cancel: - description: > - Link to the task resource that represents the "cancel" operation - for this VNF LCM operation occurrence, if cancelling is - currently allowed. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - retry: - description: > - Link to the task resource that represents the "retry" operation - for this VNF LCM operation occurrence, if retrying is currently - allowed. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - rollback: - description: > - Link to the task resource that represents the "rollback" - operation for this VNF LCM operation occurrence, if rolling back - is currently allowed. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - fail: - description: > - Link to the task resource that represents the "fail" operation - for this VNF LCM operation occurrence, if declaring as failed is - currently allowed. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + + CancelModeType: + description: > + Cancellation mode. + GRACEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or + "ROLLING_BACK" state, the VNFM shall not start any new resource + management operation and shall wait for the ongoing resource management + operations in the underlying system, typically the VIM, to finish + execution or to time out. After that, the VNFM shall put the operation + occurrence into the FAILED_TEMP state. + If the VNF LCM operation occurrence is in "STARTING" state, the VNFM + shall not start any resource management operation and shall wait for + the granting request to finish execution or time out. After that, the + VNFM shall put the operation occurrence into the ROLLED_BACK state. + FORCEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or + "ROLLING_BACK" state, the VNFM shall not start any new resource + management operation, shall cancel the ongoing resource management + operations in the underlying system, typically the VIM, and shall wait + for the cancellation to finish or to time out. After that, the VNFM + shall put the operation occurrence into the FAILED_TEMP state. + If the VNF LCM operation occurrence is in "STARTING" state, the VNFM + shall not start any resource management operation and put the operation + occurrence into the ROLLED_BACK state. + type: string + enum: + - GRACEFUL + - FORCEFUL + + LcmOperationStateType: + description: > + Value | Description + ------|------------ + STARTING | The LCM operation is starting. + PROCESSING | The LCM operation is currently in execution. + COMPLETED | he LCM operation has been completed successfully. + 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. + ROLLING_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. + type: string + enum: + - STARTING + - PROCESSING + - COMPLETED + - FAILED_TEMP + - FAILED + - ROLLING_BACK + - ROLLED_BACK + + StopType: + description: > + * FORCEFUL: The VNFM will stop the VNF immediately after accepting the + request. + * GRACEFUL: The VNFM will first arrange to take the VNF out of service + after accepting the request. Once that operation is successful or once + the timer value specified in the "gracefulStopTimeout" attribute + expires, the VNFM will stop the VNF. + type: string + enum: + - FORCEFUL + - GRACEFUL \ No newline at end of file diff --git a/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml b/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml deleted file mode 100644 index 9b5cfdfa..00000000 --- a/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (c) ETSI 2017. -# https://forge.etsi.org/etsi-forge-copyright-notice.txt - -responses: - 202-with-Location: - description: > - Accepted - - The request was accepted for processing, but the processing has not - been completed. On success, the HTTP response shall include a - "Location" HTTP header that contains the URI of the newly-created - "VNF LCM operation occurrence" resource corresponding to the - operation. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Location: - description: The resource URI of the created VNF instance - type: string - format: url - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" - 202-with-Location-empty: - description: > - Accepted - - The request was accepted for processing, but the processing has not - been completed. On success, the HTTP response shall include a - "Location" HTTP header that contains the URI of the newly-created - "VNF LCM operation occurrence" resource corresponding to the - operation. - The response body shall be empty. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - 409-another-lcm-operation-ongoing: - description: > - Conflict - - The operation cannot be executed currently, due to a conflict with the - state of the VNF instance resource. - Typically, this is due to the fact that another LCM operation is - ongoing. - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - 409-inconsistent-state: - description: > - Conflict - - Another request is in progress that prohibits the fulfilment of - the current request, or the current resource state is inconsistent - with the request. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-INSTANTIATED: - description: > - Conflict - - The operation cannot be executed currently, due to a conflict with the - state of the VNF instance resource. - Typically, this is due to the fact that the VNF instance resource is in - INSTANTIATED state. - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-not-FAILED_TEMP: - description: > - The operation cannot be executed currently, due to a conflict with the - state of the VNF instance resource. - Typically, this is due to the fact that the VNF instance resource is - not in FAILED_TEMP state, or another error handling action is starting, - such as rollback or fail. - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-NOT-INSTANTIATED: - description: > - Conflict - - The operation cannot be executed currently, due to a conflict with the - state of the VNF instance resource. - Typically, this is due to the fact that the VNF instance resource is in - NOT-INSTANTIATED state, or that another lifecycle management operation - is ongoing. - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - schema: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" diff --git a/src/SOL003/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml b/src/SOL003/VNFLifecycleManagementNotification/definitions/SOL003VNFLifecycleManagementNotification_def.yaml similarity index 100% rename from src/SOL003/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml rename to src/SOL003/VNFLifecycleManagementNotification/definitions/SOL003VNFLifecycleManagementNotification_def.yaml diff --git a/src/SOL003/definitions/SOL003_def.yaml b/src/SOL003/definitions/SOL003_def.yaml index 099b2f9a..b974c4e4 100644 --- a/src/SOL003/definitions/SOL003_def.yaml +++ b/src/SOL003/definitions/SOL003_def.yaml @@ -164,60 +164,4 @@ definitions: subscription: description: > Link to the related subscription. - $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" - - VnfInfoModificationRequest: - description: > - This type represents attribute modifications for an - "Individual VNF instance" resource, i.e. modifications to a resource - representation based on the "VnfInstance" data type. - type: object - properties: - vnfInstanceName: - description: > - New value of the "vnfInstanceName" attribute in "VnfInstance", or - "null" to remove the attribute. - type: string - vnfInstanceDescription: - description: > - New value of the "vnfInstanceDescription" attribute in - "VnfInstance", or "null" to remove the attribute. - type: string - vnfPkgId: - description: > - New value of the "vnfPkgId" attribute in "VnfInstance". - The value "null" is not permitted. - $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - vnfConfigurableProperties: - description: > - Modifications of the "vnfConfigurableProperties" attribute in - "VnfInstance". If present, these modifications shall be applied - according to the rules of JSON Merge PATCH (see IETF RFC 7396). - $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - metadata: - description: > - Modifications of the "metadata" attribute in "VnfInstance". If - present, these modifications shall be applied according to the rules - of JSON Merge PATCH (see IETF RFC 7396). - $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - extensions: - description: > - Modifications of the "extensions" attribute in "VnfInstance". If - present, these modifications shall be applied according to the rules - of JSON Merge PATCH (see IETF RFC 7396). - $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - vimConnectionInfo: - description: > - New content of certain entries in the "vimConnectionInfo" attribute - array in "VnfInstance", as defined below this table. - type: array - items: - $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - vimConnectionInfoDeleteIds: - description: > - List of identifiers entries to be deleted from the "vimConnectionInfo" - attribute array in "VnfInstance", to be used as "deleteIdList" as defined - below this table. - type: array - items: - $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" \ No newline at end of file + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" \ No newline at end of file diff --git a/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml b/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml index 1605fba6..d8e2b909 100644 --- a/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml +++ b/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml @@ -2,49 +2,96 @@ # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: - InstantiateVnfRequest: + CreateVnfRequest: type: object required: - - flavourId + - vnfdId properties: - flavourId: + vnfdId: description: > - Identifier of the VNF deployment flavour to be instantiated. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - instantiationLevelId: + Identifier that identifies the VNFD which defines the VNF instance to + be created. + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" + vnfInstanceName: description: > - Identifier of the instantiation level of the deployment flavour to be - instantiated. If not present, the default instantiation level as - declared in the VNFD is instantiated. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - extVirtualLinks: + Human-readable name of the VNF instance to be created. + type: string + vnfInstanceDescription: description: > - Information about external VLs to connect the VNF to. - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" - extManagedVirtualLinks: + Human-readable description of the VNF instance to be created. + type: string + metadata: description: > - Information about external VLs to connect the VNF to. - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData" - localizationLanguage: + If present, this attribute provides values for the "metadata" attribute in "VnfInstance", + as defined in clause 5.5.2.2. + If a “metadata” entry in this CreateVnfRequest data structure has a corresponding default + value declared in the VNFD, the value in the “metadata” entry in the CreateVnfRequest + structure takes precedence. + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + ScaleVnfRequest: + type: object + required: + - type + - aspectId + properties: + type: description: > - Localization language of the VNF to be instantiated. The value shall - comply with the format defined in IETF RFC 5646. + Indicates the type of the scale operation requested. + Permitted values: + * SCALE_OUT: adding additional VNFC instances to the VNF to increase + capacity + * SCALE_IN: removing VNFC instances from the VNF in order to release + unused capacity. type: string + enum: + - SCALE_OUT + - SCALE_IN + aspectId: + description: > + Identifier of the scaling aspect. + $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + numberOfSteps: + description: > + Number of scaling steps to be executed as part of this Scale VNF + operation. It shall be a positive number and the default value + shall be 1. + type: integer + default: 1 additionalParams: description: > - Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of - "InstantiateVnfOpConfig". + Additional parameters passed by the NFVO as input to the scaling + process, specific to the VNF being scaled, as declared in the VNFD + as part of "ScaleVnfOpConfig". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - extensions: + + ScaleVnfToLevelRequest: + description: > + This type represents request parameters for the "Scale VNF to Level" + operation. + type: object + properties: + instantiationLevelId: description: > - If present, this attribute provides values for the "extensions" attribute in "VnfInstance", - as defined in clause 5.5.2.2. If an entry with the same key exists in the VnfInstance data structure, - the VNFM shall replace its value with the value passed in the InstantiateVnfRequest data structure. + Identifier of the target instantiation level of the current + deployment flavour to which the VNF is requested to be scaled. + Either the instantiationLevelId attribute or the scaleInfo attribute + shall be included. + $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + scaleInfo: + description: > + For each scaling aspect of the current deployment flavour, indicates + the target scale level to which the VNF is to be scaled. + Either the instantiationLevelId attribute or the scaleInfo attribute + shall be included. + type: array + items: + $ref: "#/definitions/ScaleInfo" + additionalParams: + description: > + Additional parameters passed by the NFVO as input to the scaling + process, specific to the VNF being scaled, as declared in the + VNFD as part of "ScaleVnfToLevelOpConfig". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfLcmOpOcc: @@ -376,33 +423,6 @@ definitions: be absent otherwise. $ref: "#/definitions/IpOverEthernetAddressInfo" - CreateVnfRequest: - type: object - required: - - vnfdId - properties: - vnfdId: - description: > - Identifier that identifies the VNFD which defines the VNF instance to - be created. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - vnfInstanceName: - description: > - Human-readable name of the VNF instance to be created. - type: string - vnfInstanceDescription: - description: > - Human-readable description of the VNF instance to be created. - type: string - metadata: - description: > - If present, this attribute provides values for the "metadata" attribute in "VnfInstance", - as defined in clause 5.5.2.2. - If a “metadata” entry in this CreateVnfRequest data structure has a corresponding default - value declared in the VNFD, the value in the “metadata” entry in the CreateVnfRequest - structure takes precedence. - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - ExtManagedVirtualLinkInfo: type: object required: @@ -930,71 +950,6 @@ definitions: maximum value shall be <= maxScaleLevel as described in the VNFD. type: integer - ScaleVnfRequest: - type: object - required: - - type - - aspectId - properties: - type: - description: > - Indicates the type of the scale operation requested. - Permitted values: - * SCALE_OUT: adding additional VNFC instances to the VNF to increase - capacity - * SCALE_IN: removing VNFC instances from the VNF in order to release - unused capacity. - type: string - enum: - - SCALE_OUT - - SCALE_IN - aspectId: - description: > - Identifier of the scaling aspect. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - numberOfSteps: - description: > - Number of scaling steps to be executed as part of this Scale VNF - operation. It shall be a positive number and the default value - shall be 1. - type: integer - default: 1 - additionalParams: - description: > - Additional parameters passed by the NFVO as input to the scaling - process, specific to the VNF being scaled, as declared in the VNFD - as part of "ScaleVnfOpConfig". - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - - ScaleVnfToLevelRequest: - description: > - This type represents request parameters for the "Scale VNF to Level" - operation. - type: object - properties: - instantiationLevelId: - description: > - Identifier of the target instantiation level of the current - deployment flavour to which the VNF is requested to be scaled. - Either the instantiationLevelId attribute or the scaleInfo attribute - shall be included. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - scaleInfo: - description: > - For each scaling aspect of the current deployment flavour, indicates - the target scale level to which the VNF is to be scaled. - Either the instantiationLevelId attribute or the scaleInfo attribute - shall be included. - type: array - items: - $ref: "#/definitions/ScaleInfo" - additionalParams: - description: > - Additional parameters passed by the NFVO as input to the scaling - process, specific to the VNF being scaled, as declared in the - VNFD as part of "ScaleVnfToLevelOpConfig". - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - StopType: description: > * FORCEFUL: The VNFM will stop the VNF immediately after accepting the @@ -1008,11 +963,6 @@ definitions: - FORCEFUL - GRACEFUL - Version: - description: > - A Version. - type: string - VirtualStorageResourceInfo: description: > This type represents the information that allows addressing a virtualised @@ -1359,7 +1309,7 @@ definitions: description: > If present, this attribute signals modifications of the "vnfSoftwareVersion" attribute in "VnfInstance". - $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" + $ref: "SOL002SOL003_def.yaml#/definitions/Version" vnfdVersion: description: > If present, this attribute signals modifications of the @@ -1369,7 +1319,7 @@ definitions: modify the "vnfPkgId" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the "vnfPkgId” attribute. - $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" + $ref: "SOL002SOL003_def.yaml#/definitions/Version" VnfInfoModificationRequest: description: > @@ -1425,291 +1375,6 @@ definitions: items: $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - VnfInstance: - description: > - This type represents a VNF instance. - type: object - required: - - id - - vnfdId - - vnfProvider - - vnfProductName - - vnfSoftwareVersion - - vnfdVersion - - instantiationState - properties: - id: - description: > - Identifier of the VNF instance. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - vnfInstanceName: - description: > - Name of the VNF instance. - This attribute can be modified with the PATCH method. - type: string - vnfInstanceDescription: - description: > - Human-readable description of the VNF instance. - This attribute can be modified with the PATCH method. - type: string - vnfdId: - description: > - Identifier of the VNFD on which the VNF instance is based. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - vnfProvider: - description: > - Provider of the VNF and the VNFD. The value is copied from the VNFD. - type: string - vnfProductName: - description: > - Name to identify the VNF Product. The value is copied from the VNFD. - type: string - vnfSoftwareVersion: - description: > - Software version of the VNF. The value is copied from the VNFD. - $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" - vnfdVersion: - description: > - Identifies the version of the VNFD. The value is copied from the VNFD. - $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" - vnfConfigurableProperties: - description: > - Current values of the configurable properties of the VNF instance. - Configurable properties referred in this attribute are declared in - the VNFD. - ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD - based on TOSCA specifications. - VNF configurable properties are sometimes also referred to as - configuration parameters applicable to a VNF. Some of these are set - prior to instantiation and cannot be modified if the VNF is - instantiated, some are set prior to instantiation (are part of - initial configuration) and can be modified later, and others can be - set only after instantiation. The applicability of certain - configuration may depend on the VNF and the required operation of - the VNF at a certain point in time. - These configurable properties include the following standard - attributes, which are declared in the VNFD if auto-scaling and/or - auto-healing are supported by the VNF: - * isAutoscaleEnabled: If present, the VNF supports auto-scaling. If - set to true, auto-scaling is currently enabled. If set to false, - auto-scaling is currently disabled. - * isAutohealEnabled: If present, the VNF supports auto-healing. If - set to true, auto-healing is currently enabled. If set to false, - auto-healing is currently disabled. - This attribute can be modified with the PATCH method. - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - vimConnectionInfo: - description: > - Information about VIM connections to be used for managing the - resources for the VNF instance. This attribute shall only be - supported and present if VNF-related resource management in direct - mode is applicable. - This attribute can be modified with the PATCH method. - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - instantiationState: - description: > - The instantiation state of the VNF. - type: string - enum: - - NOT_INSTANTIATED - - INSTANTIATED - instantiatedVnfInfo: - description: > - Information specific to an instantiated VNF instance. This attribute - shall be present if the instantiateState attribute value is - INSTANTIATED. - type: object - required: - - flavourId - - vnfState - properties: - flavourId: - description: > - Identifier of the VNF deployment flavour applied to this VNF instance. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - vnfState: - description: > - The state of the VNF instance. - $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType" - scaleStatus: - description: > - Scale status of the VNF, one entry per aspect. - Represents for every scaling aspect how "big" the VNF has been scaled w.r.t. that aspect. - This attribute shall be present if the VNF supports scaling. - See clause B.2 for an explanation of VNF scaling. - type: array - items: - $ref: "#/definitions/ScaleInfo" - extCpInfo: - description: > - Information about the external CPs exposed by the VNF instance. - type: array - minItems: 1 - items: - $ref: "#/definitions/VnfExtCpInfo" - extVirtualLinkInfo: - description: > - Information about the external VLs the VNF instance is connected to. - type: array - items: - $ref: "#/definitions/ExtVirtualLinkInfo" - extManagedVirtualLinkInfo: - description: > - External virtual links the VNF instance is connected to. - type: array - items: - $ref: "#/definitions/ExtManagedVirtualLinkInfo" - monitoringParameters: - description: > - Active monitoring parameters. - type: array - items: - $ref: "#/definitions/MonitoringParameter" - localizationLanguage: - description: > - Information about localization language of the VNF (includes e.g. - strings in the VNFD). The localization languages supported by a VNF - can be declared in the VNFD, and localization language selection can - take place at instantiation time. - The value shall comply with the format defined in IETF RFC 5646. - type: string - vnfcResourceInfo: - description: > - Information about the virtualised compute and storage resources used - by the VNFCs of the VNF instance. - type: array - items: - $ref: "#/definitions/VnfcResourceInfo" - virtualLinkResourceInfo: - description: > - Information about the virtualised network resources used by the VLs - of the VNF instance. - type: array - items: - $ref: "#/definitions/VnfVirtualLinkResourceInfo" - virtualStorageResourceInfo: - description: > - Information on the virtualised storage resource(s) used as storage for the VNF instance. - type: array - items: - $ref: "#/definitions/VirtualStorageResourceInfo" - metadata: - description: > - Additional VNF-specific attributes that provide metadata describing the VNF instance. - These attributes represent values that are stored persistently in the VnfInstance structure - for consumption by functional blocks that invoke the VNF lifecycle management interface. - They are not consumed by the VNFM, or the lifecycle management scripts. - Modifying the values of these attributes has no effect on the VNF instance, it only affects - the information represented in the VnfInstance structure. - Metadata that are writeable are the VNF provider foresees are expected to be declared in the VNFD. - The declaration of metadata in the VNFD can optionally contain the specification of initial values. - The VNFM shall accept requests to write metadata that are not declared in the VNFD. - These attributes can be initialized with default values from the VNFD or with values - passed in the CreateVnfRequest structure (see clause 5.5.2.3). - This attributeThese attributes can be created, modified or removed with the PATCH method. - - ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. - Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes - of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with - a defined initial value. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions" - that have no declared initial value shall not be created, in order to be consistent with the semantics - of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request. - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - extensions: - description: > - Additional VNF-specific attributes that affect the lifecycle management of this VNF instance. - These attributes represent values that are stored persistently in the VnfInstance structure - for consumption by the VNFM or the lifecycle management scripts during the execution of - VNF lifecycle management operations. - All extensions that are allowed for the VNF are declared in the VNFD. The declaration of an extension - in the VNFD contains information on whether its presence is optional or required, and optionally - can specify an initial value. See note 2 and note 4. The VNFM shall reject requests to write extension - attributes that are not declared in the VNFD with a "422 Unprocessable entity" error response as defined - in clause 6.4 of ETSI GS NFV-SOL 013. - Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified - attribute values can be considered during subsequent VNF lifecycle management operations, which means that - the modified values can indirectly affect the configuration of the VNF instance. - These attributes can be initialized with default values from the VNFD or with values passed in the - InstantiateVnfRequest structure (see clause 5.5.2.4). - Attributes initialized with default values from the VNFD can be updated with values passed in the - InstantiateVnfRequest structure. - Further, these attributes can be created, modified or deleted with the PATCH method. - - Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes - of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with - a defined initial value. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions" - that have no declared initial value shall not be created, in order to be consistent with the semantics - of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request. - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - _links: - description: > - Links to resources related to this resource. - type: object - required: - - self - properties: - self: - description: URI of this resource. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - indicators: - description: Indicators related to this VNF instance, if applicable. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - instantiate: - description: > - Link to the "Instantiate VNF task" resource, if the related operation - is possible based on the current status of this VNF instance - resource (i.e. VNF instance in NOT_INSTANTIATED state). - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - terminate: - description: > - Link to the "Terminate VNF task" resource, if the related operation - is possible based on the current status of this VNF instance - resource (i.e. VNF instance is in INSTANTIATED state). - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - scale: - description: > - Link to the "Scale VNF task" resource, if the related operation is - supported for this VNF instance, and is possible based on the - current status of this VNF instance resource (i.e. VNF instance - is in INSTANTIATED state). - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - scaleToLevel: - description: > - Link to the "Scale VNF to level task" resource, if the related - operation is supported for this VNF instance, and is possible - based on the current status of this VNF instance resource - (i.e. VNF instance is in INSTANTIATED state). - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - changeFlavour: - description: > - Link to the "Change VNF flavour task" resource, if the related - operation is supported for this VNF instance, and is possible - based on the current status of this VNF instance resource - (i.e. VNF instance is in INSTANTIATED state). - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - heal: - description: > - Link to the "Heal VNF task" resource, if the related operation is - supported for this VNF instance, and is possible based on the - current status of this VNF instance resource - (i.e. VNF instance is in INSTANTIATED state). - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - operate: - description: > - Link to the "Operate VNF task" resource, if the related operation is - supported for this VNF instance, and is possible based on the - current status of this VNF instance resource - (i.e. VNF instance is in INSTANTIATED state). - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - changeExtConn: - description: > - Link to the "Change external VNF connectivity task" resource, if the related - operation is possible based on the current status of this VNF - instance resource (i.e. VNF instance is in INSTANTIATED state). - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - VnfLinkPortInfo: type: object required: -- GitLab