# Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: InstantiateVnfRequest: description: > This type represents request parameters for the "Instantiate VNF" operation. It shall comply with the provisions defined in table 5.5.2.4-1. NOTE 1: The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use with certain VNFs, for instance to ensure that these networks have certain properties such as security or acceleration features, or to address particular network topologies. The present document assumes that externally-managed internal VLs are managed by the NFVO and created towards the VIM. NOTE 2: It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance (refer to clause 4.4.1.12). type: object required: - flavourId properties: 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 declared in the VNFD is instantiated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" extVirtualLinks: description: > Information about external VLs to connect the VNF to. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" extManagedVirtualLinks: description: > Information about internal VLs that are managed by the NFVO. See note 1 and note 2. type: array items: $ref: "#/definitions/ExtManagedVirtualLinkData" vimConnectionInfo: description: > Information about VIM connections to be used for managing the resources for the VNF instance, or refer to external / externally-managed virtual links. This attribute shall only be supported and may be present if VNF-related resource management in direct mode is applicable. The VNFM shall apply the content of this attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch (see IETF RFC 7396). type: object additionalProperties: $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. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" 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" extensions: description: > If present, this attribute provides modifications to the default values, as obtained from the VNFD, of the "extensions" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling extensions during the operation are defined in clause 5.4.4.3.1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vnfConfigurableProperties: description: > If present, this attribute provides modifications to the default values, as obtained from the VNFD, of the "vnfConfigurableProperties" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling configurable properties during the operation are defined in clause 5.4.4.3.1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" ExtManagedVirtualLinkData: type: object required: - id - vnfVirtualLinkDescId - resourceId properties: id: description: > The identifier of the externally-managed internal VL instance. The identifier is assigned by the NFV-MANO entity that manages this VL instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfVirtualLinkDescId: description: > The identifier of the VLD in the VNFD for this VL. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vimConnectionId: description: > Identifier of the VIM connection to manage this resource. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" resourceProviderId: description: > Identifies the entity responsible for the management of this resource. This attribute shall only be supported and present if VNF-related resource management in indirect mode is applicable. The identification scheme is outside the scope of the present document. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" resourceId: description: > The identifier of the resource in the scope of the VIM or the resource provider. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" vnfLinkPort: description: > Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL on this network resource. If this attribute is not present, the VNFM shall create the link ports on the externally-managed VL. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VnfLinkPortData" extManagedMultisiteVirtualLinkId: description: > Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFVMANO entity that manages the externally managed multi-site VL instance. It shall be present when the present externally-managed internal VL (indicated by extManagedVirtualLinkId) is part of a multi-site VL, e.g., in support of multi-site VNF spanning several VIMs. All externally-managed internal VL instances corresponding to an internal VL created based on the same virtualLinkDescId shall refer to the same extManagedMultisiteVirtualLinkId. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" ChangeVnfFlavourRequest: description: > This type represents request parameters for the "Change VNF flavour" operation. It shall comply with the provisions defined in table 5.5.2.7-1. NOTE 1: The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use with certain VNFs, for instance to ensure that these networks have certain properties such as security or acceleration features, or to address particular network topologies. The present document assumes that externally-managed internal VLs are managed by the NFVO and created towards the VIM. NOTE 2: It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance (refer to clause 4.4.1.12). type: object required: - newFlavourId properties: 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 declared in the VNFD is instantiated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" extVirtualLinks: description: > Information about external VLs to connect the VNF to. Entries in the list of external VLs that are unchanged need not be supplied as part of this request. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" extManagedVirtualLinks: description: > Information about internal VLs that are managed by the NFVO. See notes 1 and 2. type: array items: $ref: "#/definitions/ExtManagedVirtualLinkData" vimConnectionInfo: description: > Information about VIM connections to be used for managing the resources for the VNF instance, or refer to external / externally-managed virtual links. This attribute shall only be supported and may be present if VNF-related resource management in direct mode is applicable. The VNFM shall apply the content of this attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch (see IETF RFC 7396). type: object additionalProperties: $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" extensions: description: > If present, this attribute provides modifications to the values of the "extensions" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling extensions during the operation, are defined in clause 5.4.7.3.1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vnfConfigurableProperties: description: > If present, this attribute provides modifications to the values of the "vnfConfigurableProperties" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during the operation, are defined in clause 5.4.7.3.1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" TerminateVnfRequest: description: > This type represents request parameters for the "Terminate VNF" operation. It shall comply with the provisions defined in table 5.5.2.8-1. NOTE: If the VNF is still in service, requesting forceful termination can adversely impact network service. type: object required: - terminationType properties: terminationType: description: > Indicates whether forceful or graceful termination is requested. See note. 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. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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: > This type represents request parameters for the "Operate VNF" operation. It shall comply with the provisions defined in table 5.5.2.10-1. NOTE: The "stopType" and "gracefulStopTimeout" attributes shall be absent, when the "changeStateTo" attribute is equal to "STARTED". The "gracefulStopTimeout" attribute shall be present, when the "changeStateTo" is equal to "STOPPED" and the "stopType" attribute is equal to "GRACEFUL". The "gracefulStopTimeout" attribute shall be absent, when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is equal to "FORCEFUL". The request shall be treated as if the "stopType" attribute has been set to "FORCEFUL", when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is absent. required: - changeStateTo properties: changeStateTo: description: > The desired operational state (i.e. started or stopped) to change the VNF to. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType" stopType: description: > It signals whether forceful or graceful stop is requested. See note. $ref: "#/definitions/StopType" gracefulStopTimeout: description: > The time interval (in seconds) to wait for the VNF to be taken out of service during graceful stop, before stopping the VNF. See note. type: integer additionalParams: description: > Additional parameters passed by the NFVO as input to the process, specific to the VNF of which the operation status is changed, as declared in the VNFD as part of "OperateVnfOpConfig". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" 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: description: > Information about external VLs to change (e.g. connect the VNF to). Entries in the list of external VLs that are unchanged need not be supplied as part of this request. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" 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. The VNFM shall apply the content of this attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch (see IETF RFC 7396). type: object additionalProperties: $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 "ChangeExtVnfConnectivityOpConfig".". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" ChangeCurrentVnfPkgRequest: description: > This type represents request parameters for the "Change current VNF package" operation to replace the VNF package on which a VNF instance is based. It shall comply with the provisions defined in table 5.5.2.11a-1. NOTE 1: The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use with certain VNFs, for instance to ensure that these networks have certain properties such as security or acceleration features, or to address particular network topologies. The present document assumes that externally-managed internal VLs are managed by the NFVO and created towards the VIM. NOTE 2: It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance (refer to clause 4.4.1.12). type: object required: - vnfdId properties: vnfdId: description: > Identifier of the VNFD which defines the destination VNF Package for the change. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" extVirtualLinks: description: > Information about external VLs to connect the VNF to. Entries in the list that are unchanged need not be supplied as part of this request. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" extManagedVirtualLinks: description: > Information about internal VLs that are managed by the NFVO. See notes 1 and 2. type: array items: $ref: "#/definitions/ExtManagedVirtualLinkData" 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. The VNFM shall apply the content of this attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch (see IETF RFC 7396). type: object additionalProperties: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" additionalParams: description: > Additional parameters passed by the NFVO as input to the process, specific to the VNF of which the underlying VNF package is changed, as declared in the VNFD as part of "ChangeCurrentVnfPkgOpConfig". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" extensions: description: > If present, this attribute provides modifications to the values of the "extensions" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling extensions during the operation, and needed passed parameter values in case of conflicts, are defined in clause 5.4.11a.3.1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vnfConfigurableProperties: description: > If present, this attribute provides modifications to the values of the "vnfConfigurableProperties" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during the operation, and needed passed parameter values in case of conflicts, are defined in clause 5.4.11a.3.1. $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. type: object properties: vnfInstanceName: description: > New value of the "vnfInstanceName" attribute in "VnfInstance", or "null" to remove the attribute. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" vnfInstanceDescription: description: > New value of the "vnfInstanceDescription" attribute in "VnfInstance", or "null" to remove the attribute. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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: > Modifications of the "vimConnectionInfo" attribute. If present, these modifications shall be applied according to the rules of JSON Merge Patch (see IETF RFC 7396 ). type: object additionalProperties: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" VnfInfoModifications: description: > This type represents attribute modifications that were performed on an "Individual VNF instance" resource. The attributes that can be included consist of those requested to be modified explicitly in the "VnfInfoModificationRequest" data structure, and additional attributes of the "VnfInstance" data structure that were modified implicitly e.g. when modifying the referenced VNF package. The "VnfInfoModifications" data type shall comply with the provisions defined in table 5.5.2.12a-1. NOTE: If present, this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly following a request to modify the "vnfdId" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the "vnfdId" attribute. type: object properties: vnfInstanceName: description: > If present, this attribute signals modifications of the "vnfInstanceName" attribute in "VnfInstance". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" vnfInstanceDescription: description: > If present, this attribute signals modifications of the "vnfInstanceDescription" attribute in "VnfInstance". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" vnfConfigurableProperties: description: > If present, this attribute signals modifications of the "vnfConfigurableProperties" attribute in "VnfInstance". In addition, the provisions in clause 5.7 shall apply. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" metadata: description: > If present, this attribute signals modifications of the "metadata" attribute in "VnfInstance". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" extensions: description: > If present, this attribute signals modifications of the "extensions" attribute in "VnfInstance". In addition, the provisions in clause 5.7 shall apply. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vimConnectionInfo: description: > If present, this attribute signals modifications the "vimConnectionInfo" attribute array in "VnfInstance". type: object additionalProperties: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" vnfdId: description: > If present, this attribute signals modifications of the "vnfdId" attribute in "VnfInstance". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfProvider: description: > If present, this attribute signals modifications of the "vnfProvider" attribute in "VnfInstance". See note. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" vnfProductName: description: > If present, this attribute signals modifications of the "vnfProductName" attribute in "VnfInstance". See note. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" vnfSoftwareVersion: description: > If present, this attribute signals modifications of the "vnfSoftwareVersion" attribute in "VnfInstance". See note. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" vnfdVersion: description: > If present, this attribute signals modifications of the "vnfdVersion" attribute in "VnfInstance". See note. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" StopType: description: > * FORCEFUL: The VNFM will stop the VNF instance immediately after accepting the request. * GRACEFUL: The VNFM instance 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 instance. type: string enum: - FORCEFUL - GRACEFUL CreateVnfSnapshotRequest: description: > This type represents request parameters for the "Create VNF Snapshot" LCM operation which takes a snapshot of a VNF instance and populates a previously-created "Individual VNF snapshot" resource with the content of the snapshot. It shall comply with the provisions defined in table 5.5.2.21-1. type: object required: - vnfSnapshotResId properties: vnfSnapshotInfoId: description: > Identifier of the "Individual VNF snapshot" resource to which the VNF snapshot is to be associated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" additionalParams: description: > Additional input parameters for the snapshot creation process, specific for the VNF being “snapshotted”, as declared in the VNFD as part of “CreateSnapshotVnfOpConfig”. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" userDefinedData: description: > User defined data for the VNF snapshot. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" CreateVnfSnapshotInfoRequest: description: | This type represents request parameters for the creation of an "Individual VNF snapshot" resource which can be populated with content obtained by invoking the "Create VNF snapshot" LCM operation or extracted from a VNF snapshot package. It shall comply with the provisions defined in table 5.5.2.20-1. NOTE: The present attribute shall be provided if the "Individual VNF snapshot" resource is requested to be created as part of a VNF snapshot package extraction. type: object properties: vnfSnapshotPkgId: description: | Identifier of the VNF snapshot package information held by the NFVO. See note. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfSnapshot: description: | Information about the VNF snapshot, content and/or reference to its content. $ref: "#/definitions/VnfSnapshot" RevertToVnfSnapshotRequest: description: > This type represents request parameters for the "Revert to VNF Snapshot" operation. type: object required: - vnfSnapshotInfoId properties: vnfSnapshotInfoId: description: > Identifier of the "Individual VNF snapshot" resource with the information of the VNF snapshot to be reverted to. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" additionalParams: description: > Additional input parameters for the revert to VNF snapshot process, specific for the VNF being “reverted”, as declared in the VNFD as part of “RevertToSnapshotVnfOpConfig”. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfSnapshotInfoModificationRequest: description: | This type represents attribute modifications for an "Individual VNF snapshot" resource, i.e. modifications to a resource representation based on the "VnfSnapshotInfo" data type. The attributes of "VnfSnapshotInfo" that can be modified according to the provisions in clause 5.5.2.22 are included in the "VnfSnapshotInfoModificationRequest" data type. The "VnfSnapshotInfoModificationRequest" data type shall comply with the provisions defined in table 5.5.2.24-1. type: object properties: vnfSnapshotPkgId: description: | New value of the "vnfSnapshotPkgId" attribute in "VnfSnapshotInfo". The value "null" is not permitted. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfSnapshot: description: | New value of the "vnfSnapshot" attribute in "VnfSnapshotInfo". The value "null" is not permitted. $ref: "#/definitions/VnfSnapshot" VnfSnapshotInfoModifications: description: | This type represents attribute modifications that were performed on an "Individual VNF snapshot" resource. The attributes that can be included consist of those requested to be modified explicitly in the "VnfSnapshotInfoModificationRequest" data structure, and additional attributes of the "VnfSnapshotInfo" data structure that were modified implicitly. The "VnfSnapshotInfoModifications" data type shall comply with the provisions defined in table 5.5.2.25-1. type: object properties: vnfSnapshotPkgId: description: | If present, this attribute signals modifications of the "vnfSnapshotPkgId" attribute in "VnfSnapshotInfo" as defined in clause 5.5.2.22. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfSnapshot: description: | If present, this attribute signals modifications of the "vnfSnapshot" attribute in "VnfSnapshotInfo" as defined in clause 5.5.2.22. $ref: "#/definitions/VnfSnapshot" VnfInstance: description: > This type represents a VNF instance. It shall comply with the provisions defined in table 5.5.2.2-1. NOTE: Clause B.3.2 provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity of a VNF. NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist between the previous and the newly referred VNF package, i.e. when the new VNFD is changed with respect to the previous VNFD in other aspects than merely referencing to other VNF software images. In order to avoid misalignment of the VnfInstance with the current VNF's on-boarded VNF Package, the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall be kept in sync with the values in the VNFD. NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 3: 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. NOTE 4: 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. The defined initial values can be declared in the VNFD, and/or, in case of "metadata", obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions" that have no defined 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. NOTE 5: It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding to the same VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance (refer to clause 5.5.3.3). NOTE 6: Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant. type: object required: - id - vnfdId - vnfProvider - vnfProductName - vnfSoftwareVersion - vnfdVersion - instantiationState properties: id: description: > Identifier of the VNF instance. $ref: "../../../definitions/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. See note 1. $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: > Additional VNF-specific attributes that provide the current values of the configurable properties of the VNF instance. These attributes represent values that are stored persistently in the VnfInstance structure and that correspond to configuration parameters of the VNF instance. Modifying these attributes affects the configuration of the VNF instance either directly (if the VNF instance is in INSTANTIATED state at the time of the modification) or as part of the subsequent VNF instantiation operation (if the VNF instance is in NOT_INSTANTIATED state at the time of the modification). Configurable properties referred in these attributes are declared in the VNFD. The declaration of configurable properties in the VNFD can optionally contain the specification of initial values. See notes 2, 3 and 4. The VNFM shall reject requests to write configurable properties 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. 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. These configurable properties can be initialized with default values from the VNFD (see note 4). Configurable properties can be modified with values passed in the request structures of certain LCM operations, such as the InstantiateVnfRequest structure. Further, these configurable properties can be created, modified or deleted with the PATCH method. In addition, the provisions in clause 5.7 shall apply. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vimConnectionInfo: description: > Information about VIM connections to be used for managing the resources for the VNF instance. The keys of the map, each of which identifies information about a particular VIM connection, are managed by the NFVO and referenced from other data structures via the "vimConnectionId" attribute. This attribute shall only be supported and present if VNF-related resource management in direct mode is pplicable. This attribute can be modified with the PATCH method. type: object additionalProperties: $ref: "../../../definitions/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: "../../../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" maxScaleLevels: description: > Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo" extCpInfo: description: > Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated to sub-ports of a trunk. type: array minItems: 1 items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfExtCpInfo" vipCpInfo: description: > VIP CPs that are part of the VNF instance. Shall be present when that particular VIP CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise. type: array minItems: 1 items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VipCpInfo" 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: > Information about the externally-managed internal VLs of the VNF instance. See note 5 and note 6. type: array items: $ref: "#/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/VnfcResourceInfo" vnfVirtualLinkResourceInfo: description: > Information about the virtualised network resources used by the VLs of the VNF instance. See note 6. 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 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. See notes 2 and 4. 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 (see note 4) or with values passed in the CreateVnfRequest structure (see clause 5.4.2.3.1). These attributes can be created, modified or removed with the PATCH method. $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 notes 2 and 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 (see note 4). These attributes can be modified with values passed in the request structures of certain LCM operations, such as the InstantiateVnfRequest structure. Further, these attributes can be created, modified or deleted with the PATCH method. In addition, the provisions in clause 5.7 shall apply. _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" createSnapshot: description: > Link to the "Create VNF snapshot 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" revertToSnapshot: description: > Link to the "Revert to VNF snapshot 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" ExtManagedVirtualLinkInfo: type: object required: - id - vnfVirtualLinkDescId - networkResource properties: id: description: > Identifier of the externally-managed internal VL and the related externally-managed VL information instance. The identifier is assigned by the NFV-MANO entity that manages this VL instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfVirtualLinkDescId: description: > Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfdId: description: > Identifier of the VNFD. Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change current VNF package" operation or due to its final failure). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" networkResource: description: > Reference to the VirtualNetwork resource providing this VL. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" vnfLinkPorts: description: > Link ports of this VL. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLinkPortInfo" extManagedMultisiteVirtualLinkId: description: > Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFVMANO entity that manages the externally managed multi-site VL instance. It shall be present when the externally-managed internal VL is part of a multi-site VL, e.g., in support of multi-site VNF spanning several VIMs. All externally-managed internal VL instances corresponding to an internal VL created based on the same virtualLinkDescId shall refer to the same extManagedMultisiteVirtualLinkId. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" VirtualStorageResourceInfo: description: > This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. type: object required: - id - virtualStorageDescId - storageResource properties: id: description: > Identifier of this VirtualStorageResourceInfo instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" virtualStorageDescId: description: > Identifier of the VirtualStorageDesc in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfdId: description: > Identifier of the VNFD. Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change current VNF package" operation or due to its final failure). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" storageResource: description: > Reference to the VirtualStorage resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" zoneId: description: > The identifier of the resource zone, as managed by the resource management layer (typically, the VIM), where the referenced VirtualStorage resource is placed. Shall be provided if this information is available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" reservationId: description: > The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfcResourceInfo: description: > This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance. It shall comply with the provisions defined in table 5.5.3.5-1. NOTE 1: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 2: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. NOTE 3: The information can be omitted because it is already available as part of the external CP information. type: object required: - id - vduId - computeResource properties: id: description: > Identifier of this VnfcResourceInfo instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vduId: description: > Reference to the applicable VDU in the VNFD. See note 1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfdId: description: > Identifier of the VNFD. Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change current VNF package" operation or due to its final failure). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" computeResource: description: > Reference to the VirtualCompute resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" zoneId: description: > The identifier of the resource zone, as managed by the resource management layer (typically, the VIM), where the referenced VirtualCompute resource is placed. Shall be provided if this information is available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" storageResourceIds: description: > References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" reservationId: description: > The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfcCpInfo: description: > CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance or is connected to an external CP of the VNF instance. See note 2. May be present otherwise. type: array items: type: object required: - id - cpdId properties: id: description: > Identifier of this VNFC CP instance and the associated array entry. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the VDU CPD, cpdId, in the VNFD. See note 1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfExtCpId: description: > Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of the VNF instance or connected to an external CP of the VNF instance (see note 2) and shall be absent otherwise. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpProtocolInfo: description: > Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. See note 3. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CpProtocolInfo" vnfLinkPortId: description: > Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtualLinkInfo" structure. Shall be present if the CP is associated to a link port on an internal VL (including externally-managed internal VL) of the VNF instance and shall be absent otherwise. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" metadata: description: > Metadata about this CP. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" parentCpId: description: > Identifier of another VNFC CP instance that corresponds to the parent port of a trunk that the present VNFC CP instance participates in. Shall be provided if the present CP instance participates in a trunk as subport, and the referred VNFC CP instances are also present in the vnfcCpInfo attribute. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" metadata: description: > Metadata about this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfSnapshotInfo: description: > This type represents an "Individual VNF snapshot" resource. It shall comply with the provisions defined in table 5.5.2.22-1. type: object required: - id - _links properties: id: description: > Identifier of the "Individual VNF snapshot" resource. This identifier is allocated by the VNFM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfSnapshotPkgId: description: > Identifier of the VNF snapshot package information held by the NFVO. Shall be present when the “Individual VNF snapshot" resource is created from a VNF snapshot package extraction. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfSnapshot: description: > Information about the VNF snapshot, content and/or references to its content. Shall be present when the "Individual VNF snapshot" resource is associated to a VNF snapshot created via the corresponding "Create VNF Snapshot" task resource or extracted from a VNF snapshot package. $ref: "#/definitions/VnfSnapshot" _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" takenFrom: description: > Link to the VNF instance from which this snapshot was taken. Shall be present when the "Individual VNF snapshot" resource is associated to a VNF snapshot created via the corresponding "Create VNF snapshot" task resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" VnfStateSnapshotInfo: description: > This type represents information about VNF-specific state snapshot data. type: object required: - checksum - isEncrypted properties: checksum: description: > Checksum of the VNF state snapshot file. Hash algorithms applicable to VNF snapshot package artifacts are defined in ETSI GS NFV-SOL 010. $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" isEncrypted: description: > Reflects whether the VNF state snapshot content is encrypted (true) or not (false). $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" metadata: description: > The metadata with additional information such as content type, size, creation date, etc. $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfSnapshot: description: > This type represents a VNF snapshot. It shall comply with the provisions defined in table 5.5.2.23-1. type: object required: - id - vnfInstanceId - triggeredAt - vnfdId - vnfInfo - vnfcSnapshots properties: id: description: > Identifier of the VNF Snapshot. This identifier is allocated by the VNFM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfInstanceId: description: > Identifier of the snapshotted VNF instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" creationStartedAt: description: > Timestamp indicating when the VNF snapshot creation has been started by the VNFM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" creationFinishedAt: description: > Timestamp indicating when the VNF snapshot has been completed by the VNFM. Shall be present once the VNF snapshot creation has been completed. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" vnfdId: description: > Identifier of the VNFD in use at the time the snapshot of the VNF instance has been created. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfInstance: description: > VNF Instance information of the snapshotted VNF instance. This is a copy of the "ndividual VNF instance" resource. $ref: '#/definitions/VnfInstance' vnfcSnapshots: description: > Information about VNFC snapshots constituting this VNF snapshot. type: array items: $ref: '#/definitions/VnfcSnapshotInfo' vnfStateSnapshotInfo: description: > Information about VNF-specific state snapshot data. This attribute shall not be present before the VNF snapshot has been completed. Otherwise, this attribute shall be present if the VNF snapshot has associated additional VNF-specific state data. $ref: '#/definitions/VnfStateSnapshotInfo' userDefinedData: description: > User defined data for the VNF snapshot. $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" vnfStateSnapshot: description: > Link to the "VNF state snapshot" resource. This attribute shall not be present before the VNF snapshot has been completed. Otherwise, this attribute shall be present if the VNF snapshot has associated additional VNFspecific state data. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" VnfcSnapshotInfo: description: > This type represents a VNFC snapshot. It shall comply with the provisions defined in table 5.5.3.19-1. NOTE 1: The identifier of the compute snapshot resource is assigned during creation of a VNFC snapshot being returned from the VIM as output data in the response message of the individual resource operations. This attribute shall only be present for a VNFC snapshot that has been newly created by the VNFM as a result of the "Create VNF snapshot task". NOTE 2: The identifier of the storage snapshot resource is assigned during creation of a VNFC snapshot being returned from the VIM as output data in the response message of the individual resource operations. This attribute shall only be present for a VNFC snapshot with an associated storage resource and that has been newly created by the VNFM as a result of the "Create VNF snapshot task". type: object required: - id - vnfcInstanceId - triggeredAt - vnfcResourceId properties: id: description: > Identifier of the information held by the VNFM about a specific VNFC snapshot. This identifier is allocated by the VNFM and is unique within the scope of a VNF snapshot. The attribute also identifies the compute snapshot image associated to this VNFC snapshot within the context of a referred VNF snapshot. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" vnfcInstanceId: description: > Identifier of the snapshotted VNFC instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" creationStartedAt: description: > Timestamp indicating when the VNF snapshot creation has been started by the VNFM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" creationFinishedAt: description: > Timestamp indicating when the VNFC snapshot has been completed. Shall be present once the VNFC snapshot creation has been completed by the VNFM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" vnfcResourceInfoId: description: > Reference to the "VnfcResourceInfo" structure in the "VnfInstance" structure that represents the resource of the snapshotted VNFC instance. A snapshot of that structure is available in the "vnfInstance" attribute of the "VnfSnapshot" structure. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" computeSnapshotResource: description: > Reference to a compute snapshot resource. See note 1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" storageSnapshotResources: description: > Mapping of the storage resources associated to the VNFC with the storage snapshot resources. type: array items: type: object required: - storageResourceId properties: storageResourceId: description: > Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure that represents the virtual storage resource. The attribute also identifies the storage snapshot image associated to this VNFC snapshot within the context of a referred VNF snapshot. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" storageSnapshotResource: description: > Reference to a storage snapshot resource. See note 2. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" userDefinedData: description: > User defined data for the VNFC snapshot. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfVirtualLinkResourceInfo: description: > This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance. type: object required: - id - vnfVirtualLinkDescId - networkResource properties: id: description: > Identifier of this VnfVirtualLinkResourceInfo instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfVirtualLinkDescId: description: > Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfdId: description: > Identifier of the VNFD. Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change current VNF package" operation or due to its final failure). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" networkResource: description: > Reference to the VirtualNetwork resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" zoneId: description: > The identifier of the resource zone, as managed by the resource management layer (typically, the VIM), where the referenced VirtualNetwork resource is placed. Shall be provided if this information is available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" reservationId: description: > The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfLinkPorts: description: > Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLinkPortInfo" metadata: description: > Metadata about this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" AffectedVnfc: description: > This type provides information about added, deleted, modified and temporary VNFCs. It shall comply with the provisions in table 5.5.3.13-1. NOTE: The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in correlating the resource changes performed during the LCM operation with the granted resources in a specific Grant exchange, which is identified by the "grantId" available in the "Individual VNF lifecycle management operation occurrence" and the "id" in the "Individual Grant". type: object required: - id - vduId - changeType - computeResource properties: id: description: > Identifier of the Vnfc instance, identifying the applicable "vnfcResourceInfo" entry in the "VnfInstance" data type. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vduId: description: > Identifier of the related VDU in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfdId: description: > Identifier of the VNFD. Shall be present in case of a "change current VNF Package" to identify whether the affected VNFC instance is associated to a VDU which is referred from the source or destination VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" changeType: description: > Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists. type: string enum: - ADDED - REMOVED - MODIFIED - TEMPORARY computeResource: description: > Reference to the VirtualCompute resource. Detailed information is (for new and modified resources) or has been (for removed resources) available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" resourceDefinitionId: description: > The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. It shall be present when an applicable GrantInfo for thegranted resource exists. See note. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" zoneId: description: > The identifier of the resource zone, as managed by the resource management layer (typically, the VIM), where the referenced VirtualCompute resource is placed. Shall be provided if this information is available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this resource. The content of this attribute shall be a copy of the content of the "metadata" attribute of the VnfcResourceInfo structure. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" affectedVnfcCpIds: description: > Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" addedStorageResourceIds: description: > References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" removedStorageResourceIds: description: > References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" VnfLcmOpOcc: description: > This type represents a VNF lifecycle management operation occurrence. It shall comply with the provisions defined in table 5.5.2.13-1. NOTE 1: 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. NOTE 2: Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present. NOTE 3: For a particular affected VL, there shall be as many "AffectedVirtualLink" entries as needed for signalling the different types of changes, i.e. one per virtual link and change type. For instance, in the case of signaling affected VL instances involving the addition of a particular VL instance with links ports, one "AffectedVirtualLink" entry signals the addition of the VL by using the "changeType" attribute of "AffectedVirtualLink" structure equal to "ADDED", and another "AffectedVirtualLink" entry signals the addition of externally visible VNF link ports of the VL by using the "changeType" equal to "LINK_PORT_ADDED". NOTE 4: A coordination action has timed out if the VNFM has not been able to read the "Individual coordination action" resource within a timeout interval after requesting the coordination to be started or to be cancelled. The length of the timeout interval is defined by means outside the scope of the present document. NOTE 5: The list of rejected coordinations may be garbage collected if the LCM operation occurrence has reached a terminal state, i.e. one of "COMPLETED", "FAILED" and "ROLLED_BACK". type: object oneOf: - required: - changedInfo - required: - modificationsTriggeredByVnfPkgChange required: - id - operationState - stateEnteredTime - startTime - vnfInstanceId - operation - isAutomaticInvocation - isCancelPending 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 has been entered. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" startTime: description: > Date-time of the start of the operation. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" 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. Shall be set to the value of the "id" attribute in the "Grant" representing the associated "Individual Grant", 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. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" operationParams: description: > Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. In addition, the provisions in clause 5.7 shall apply. 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: VnfInfoModifications * CREATE_SNAPSHOT: CreateVnfSnapshotRequest * REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest * CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest type: object 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. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" cancelMode: description: > The mode of an ongoing cancellation. Shall be present when isCancelPending=true, and shall be absent otherwise. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/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. See note 1. type: array items: $ref: "#/definitions/AffectedVnfc" affectedVirtualLinks: description: > Information about VL instances that were affected during the lifecycle operation. See notes 1 and 3. type: array items: $ref: "#/definitions/AffectedVirtualLink" affectedExtLinkPorts: description: > Information about external VNF link ports that were affected during the lifecycle operation. See note 1. type: array items: $ref: "#/definitions/AffectedExtLinkPort" affectedVirtualStorages: description: > Information about virtualised storage instances that were affected during the lifecycle operation. See note 1. type: array items: $ref: "#/definitions/AffectedVirtualStorage" changedInfo: description: > Information about the changed VNF instance information, including VNF configurable properties, if applicable. See note 1 and note 2. $ref: "#/definitions/VnfInfoModifications" affectedVipCps: description: > Information about virtual IP CP instances that were affected during the execution of the lifecycle management operation. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVipCp" changedExtConnectivity: description: > Information about changed external connectivity, if applicable. See note 1. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" modificationsTriggeredByVnfPkgChange: description: > Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package, if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG". See notes 1 and 2. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange" vnfSnapshotInfoId: description: > Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation, i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" lcmCoordinations: description: > Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) related to this LCM operation occurrence. type: array items: type: object required: - id - coordinationActionName - startTime - endpointType properties: id: description: > Identifier of this coordination action. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" coordinationActionName: description: > Indicator of the actual coordination action. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" coordinationResult: description: > The result of executing the coordination action which also implies the action to be performed by the VNFM as the result of this coordination. Shall be present if the coordination has been finished. Shall be absent if the coordination is ongoing or has timed out (see note 4). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmCoordResultType" startTime: description: > The time when the VNFM has received the confirmation that the coordination action has been started. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" endTime: description: > The time when the VNFM has received the confirmation that the coordination action has finished or has been cancelled, or the time when a coordination action has timed out. Shall be present for a coordination action that has finished or timed out (see note 4) and shall be absent if the coordination is ongoing. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" delay: description: > The end of the delay period. This attribute shall be present if the last known HTTP response related to this coordination has contained a "Retry-After" header, and shall be absent otherwise. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" endpointType: description: > The endpoint type used by this coordination action. Valid values: • MGMT: coordination with other operation supporting management systems (e.g. EM) • VNF: coordination with the VNF instance type: string enum: - MGMT - VNF rejectedLcmCoordinations: description: > Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) that were rejected by 503 error which means they can be tried again after a delay. See note 5. type: array items: type: object required: - coordinationActionName - rejectionTime - endpointType - delay properties: coordinationActionName: description: > Indicator of the actual coordination action. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" rejectionTime: description: > The time when the VNFM has received the 503 response that rejects the actual coordination. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" delay: description: > The end of the delay period, as calculated from the startTime and "Retry-After" header. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" endpointType: description: > The endpoint type used by this coordination action. Valid values: • MGMT: coordination with other operation supporting management systems (e.g. EM) • VNF: coordination with the VNF instance type: string enum: - MGMT - VNF warnings: description: > Warning messages that were generated while the operation was executing. If the operation has included LCM coordination actions and these have resulted in warnings, such warnings should be added to this attribute. type: array items: type: string _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" vnfSnapshot: description: > Link to the VNF snapshot resource, if the VNF LCM operation occurrence is related to a VNF snapshot. Shall be present if operation="CREATE_SNAPSHOT" or operation="REVERT_TO_SNAPSHOT". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" AffectedExtLinkPort: description: > This type provides information about added and deleted external link ports (link ports attached to external virtual links). It shall comply with the provisions in table 5.5.3.14a-1. NOTE: The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in correlating the resource changes performed during the LCM operation with the granted resources in a specific Grant exchange, which is identified by the "grantId" available in the "Individual VNF lifecycle management operation occurrence" and the "id" in the "Individual Grant". type: object required: - id - changeType - extCpInstanceId - resourceHandle properties: id: description: > Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" data type (see clause 5.5.3.2). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" changeType: description: > Signals the type of change. Permitted values: - ADDED - REMOVED type: string enum: - ADDED - REMOVED extCpInstanceId: description: > Identifier of the related external CP instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" resourceHandle: description: > Reference to the link port resource. Detailed information is (for added resources) or has been (for removed resources) available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" resourceDefinitionId: description: > The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. It shall be present when an applicable GrantInfo for the granted resource exists. See note. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" VnfLcmOperationOccurrenceNotification: description: > This type represents a VNF lifecycle management operation occurrence notification, which informs the receiver of changes in the VNF lifecycle caused by a VNF LCM operation occurrence. It shall comply with the provisions defined in table 5.5.2.17-1. The support of the notification is mandatory. This notification shall be triggered by the VNFM when there is a change in the state of a VNF LCM operation occurrence that changes the VNF lifecycle, which represents an occurrence of one the following LCM operations: - Instantiation of the VNF - Scaling of the VNF instance (including auto-scaling) - Healing of the VNF instance (including auto-healing) - Change of the state of the VNF instance (i.e. Operate VNF) - Change of the deployment flavour of the VNF instance - Change of the external connectivity of the VNF instance - Change of the current VNF package - Termination of the VNF instance - Modification of VNF instance information and/or VNF configurable properties through the "PATCH" method on the "Individual VNF instance" resource - Creation of a VNF snapshot - Reversion of the VNF instance to a VNF snapshot Clause 5.6.2 defines the states and state transition of a VNF LCM operation occurrence, and also specifies details of the notifications to be emitted at each state transition. If this is the initial notification about the start of a VNF LCM operation occurrence, it is assumed that the notification is sent by the VNFM before any action (including sending the grant request) is taken as part of the LCM operation. Due to possible race conditions, the "start" notification, the grant request and the LCM operation acknowledgment (i.e. the "202 Accepted" response) can arrive in any order at the NFVO, and the NFVO shall be able to handle such a situation. If this is a notification about a final or intermediate result state of a VNF LCM operation occurrence, the notification shall be sent after all related actions of the LCM operation that led to this state have been executed. The new state shall be set in the "Individual VNF LCM operation occurrence" resource before the notification about the state change is sent. The amount of information provided in the LCM operation occurrence notifications to be issued by the VNFM when a particular subscription matches can be controlled by the API consumer using the "verbosity" attribute in the subscription request (see clause 5.5.2.15). The "verbosity" setting in a particular individual subscription shall only apply to the LCM operation occurrence notifications triggered by that subscription. However, it shall not affect the amount of information in the "VnfLcmOpOcc" structure (see clause 5.5.2.13) which represents the "Individual LCM operation occurrence" resource associated with each of the notifications. See clause 5.6.2.2 for further provisions regarding sending this notification, including in cases of handling LCM operation errors. NOTE 1: Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM operation occurrence and by any of the error handling procedures for that operation occurrence. NOTE 2: For a particular affected VL, there shall be as many "AffectedVirtualLink" entries as needed for signalling the different types of changes, i.e. one per virtual link and change type. For instance, in the case of signaling affected VL instances involving the addition of a particular VL instance with links ports, one "AffectedVirtualLink" entry signals the addition of the VL by using the "changeType" attribute of "AffectedVirtualLink" structure equal to "ADDED", and another "AffectedVirtualLink" entry signals the addition of externally visible VNF link ports of the VL by using the "changeType" equal to "LINK_PORT_ADDED". type: object required: - id - notificationType - subscriptionId - timeStamp - notificationStatus - operationState - vnfInstanceId - operation - isAutomaticInvocation - vnfLcmOpOccId - _links properties: id: description: > Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "VnfLcmOperationOccurrenceNotification" for this notification type. type: string enum: - VnfLcmOperationOccurrenceNotification subscriptionId: description: > Identifier of the subscription that this notification relates to.Shall be set to the value of the "id" attribute of the "LccnSubscription" representing the associated "Individual subscription" resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" notificationStatus: description: > Indicates whether this notification reports about the start of a lifecycle operation or the result of a lifecycle operation. Permitted values: * START: Informs about the start of the VNF LCM operation occurrence. * RESULT: Informs about the final or intermediate result of the VNF LCM operation occurrence. type: string enum: - START - RESULT operationState: description: > The state of the VNF LCM operation occurrence. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType" vnfInstanceId: description: > The identifier of the VNF instance affected. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" operation: description: > The lifecycle management operation. $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 verbosity: description: > This attribute signals the verbosity of the notification. If it is not present, it shall default to the value "FULL". If the value is "SHORT", full change details can be obtained by performing a GET request on the "Individual LCM operation occurrence" resource that is signalled by the "vnfLcmOpOcc" child attribute of the "_links" attribute. $ref: '../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOpOccNotificationVerbosityType' vnfLcmOpOccId: description: > The identifier of the VNF lifecycle management operation occurrence associated to the notification. Shall be set to the value of the "id" attribute of the "VnfLcmOpOcc" representing the associate "Individual VNF lifecycle management operation occurrence" resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" affectedVnfcs: description: > Information about VNFC instances that were affected during the lifecycle operation. See note 1. type: array items: $ref: "#/definitions/AffectedVnfc" affectedVirtualLinks: description: > Information about VL instances that were affected during the lifecycle operation. See note 1 and note 2. type: array items: $ref: "#/definitions/AffectedVirtualLink" affectedExtLinkPorts: description: > Information about external VNF link ports that were affected during the lifecycle operation. See note 1. type: array items: $ref: "#/definitions/AffectedExtLinkPort" affectedVirtualStorages: description: > Information about virtualised storage instances that were affected during the lifecycle operation. See note 1. type: array items: $ref: "#/definitions/AffectedVirtualStorage" changedInfo: description: > Information about the changed VNF instance information, including changed VNF configurable properties. Shall be present if the "notificationStatus" is set to "RESULT", the "operation" attribute is not equal to "CHANGE_VNFPKG", the "verbosity" attribute is set to "FULL" and the operation has performed any changes to VNF instance information, including VNF configurable properties. Shall be absent otherwise. $ref: "#/definitions/VnfInfoModifications" affectedVipCps: description: > Information about virtual IP CP instances that were affected during the execution of the lifecycle management operation, if this notification represents the result of a lifecycle management operation occurrence. Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL" and the operation has made any changes to the VIP CP instances of the VNF instance. Shall be absent otherwise. Only information about VIP CP instances that have been added, deleted or modified shall be provided. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVipCp" changedExtConnectivity: description: > Information about changed external connectivity, if this notification represents the result of a lifecycle operation occurrence. Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL" and the operation has made any changes to the external connectivity of the VNF instance. Shall be absent otherwise. Only information about external VL instances that have been added or modified shall be provided. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" modificationsTriggeredByVnfPkgChange: description: > Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package. Shall be present if the "notificationStatus" is set to "RESULT", the "operation" attribute is equal to "CHANGE_VNFPKG", the "verbosity" attribute is set to "FULL" and the operation has performed any changes to VNF instance information, including VNF configurable properties. Shall be absent otherwise. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange" error: description: > Details of the latest error, if one has occurred during executing the LCM operation (see clause 6.3 of ETSI GS NFV-SOL 013). Shall be present if the "operationState" attribute is "FAILED_TEMP", "FAILED" or "ROLLED_BACK" and shall be absent otherwise. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" _links: description: > Links to resources related to this notification. The link URIs in this structure shall be set to point to the resources identified by the corresponding identifier attributes in this notification. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnLinks" AffectedVirtualLink: description: > This type provides information about added, deleted, modified and temporary VLs, and added or removed VNF link ports. NOTE 1: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the "networkResource" and "resourceDefinitionId" attributes refer to the affected virtual link instance, not the link port instance. The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the "vnfLinkPortIds" attribute. NOTE 2: The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in correlating the resource changes performed during the LCM operation with the granted resources in a specific Grant exchange, which is identified by the "grantId" available in the "Individual VNF lifecycle management operation occurrence" and the "id" in the "Individual Grant". type: object required: - id - vnfVirtualLinkDescId - changeType - networkResource properties: id: description: > Identifier of the virtual link instance, identifying the applicable "vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" entry in the "VnfInstance" data type. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfVirtualLinkDescId: description: > Identifier of the related VLD in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfdId: description: > Identifier of the VNFD. Shall be present in case of a "change current VNF Package" to identify whether the affected VL instance is associated to a VLD which is referred from the source or destination VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" changeType: description: > Signals the type of change. Permitted values: - ADDED - REMOVED - MODIFIED - TEMPORARY - LINK_PORT_ADDED - LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists. See note 1. type: string enum: - ADDED - REMOVED - MODIFIED - TEMPORARY - LINK_PORT_ADDED - LINK_PORT_REMOVED networkResource: description: > Reference to the VirtualNetwork resource. Detailed information is (for new and modified resources) or has been (for removed resources) available from the VIM. See note 1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" vnfLinkPortIds: description: > Identifiers of the link ports of the affected VL related to the change. Each identifier references a "VnfLinkPortInfo" structure. Shall be set when changeType is equal to "LINK_PORT_ADDED" or "LINK_PORT_REMOVED", and the related "VnfLinkPortInfo" structures are present (case "added") or have been present (case "removed") in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtualLinkInfo" structures that are represented by the "vnfVirtualLinkResource¬Info" or "extManagedVirtualLinkInfo" attribute in the "VnfInstance" structure. See note 1. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" resourceDefinitionId: description: > The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. It shall be present when an applicable GrantInfo for the granted resource exists. See note 1 and note 2. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" zoneId: description: > The identifier of the resource zone, as managed by the resource management layer (typically, the VIM), where the referenced VirtualNetwork resource is placed. Shall be provided if this information is available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this resource. The content of this attribute shall be a copy of the content of the "metadata" attribute of the applicable "vnfVirtualLinkResourceInfo” structure if such structure is referenced by the "id" attribute and it has metadata. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" AffectedVirtualStorage: description: > This type provides information about added, deleted, modified and temporary virtual storage resources. It shall comply with the provisions in table 5.5.3.15-1. NOTE: The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in correlating the resource changes performed during the LCM operation with the granted resources in a specific Grant exchange, which is identified by the "grantId" available in the "Individual VNF lifecycle management operation occurrence" and the "id" in the "Individual Grant". type: object required: - id - virtualStorageDescId - changeType - storageResource properties: id: description: > Identifier of the storage instance, identifying the applicable "virtualStorageResourceInfo" entry in the "VnfInstance" data type. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" virtualStorageDescId: description: > Identifier of the related VirtualStorage descriptor in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfdId: description: > Identifier of the VNFD. Shall be present in case of a "change current VNF Package" to identify whether the affected virtual storage instance is associated to a VirtualStorage descriptor which is referred from the source or destination VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" changeType: description: > Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists. type: string enum: - ADDED - REMOVED - MODIFIED - TEMPORARY storageResource: description: > Reference to the VirtualStorage resource. Detailed information is (for new and modified resources) or has been (for removed resources) available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" resourceDefinitionId: description: > The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. It shall be present when an applicable GrantInfo for the granted resource exists. See note. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" zoneId: description: > The identifier of the resource zone, as managed by the resource management layer (typically, the VIM), where the referenced VirtualNetwork resource is placed. Shall be provided if this information is available from the VIM. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this resource. The content of this attribute shall be a copy of the content of the "metadata" attribute of the VirtualStorageResourceInfo structure. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"