# Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: CreateVnfRequest: type: object required: - vnfdId properties: vnfdId: description: > Identifier that identifies the VNFD which defines the VNF instance to be created. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" vnfInstanceName: description: > Human-readable name of the VNF instance to be created. type: string vnfInstanceDescription: description: > Human-readable description of the VNF instance to be created. type: string metadata: description: > If present, this attribute provides additional initial values, overriding those obtained from the VNFD, for the "metadata" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling metadata during the operation are defined in clause 5.4.2.3.1. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" ScaleVnfRequest: type: object required: - type - aspectId properties: type: description: > Indicates the type of the scale operation requested. Permitted values: * SCALE_OUT: adding additional VNFC instances to the VNF to increase capacity * SCALE_IN: removing VNFC instances from the VNF in order to release unused capacity. type: string enum: - SCALE_OUT - SCALE_IN aspectId: description: > Identifier of the scaling aspect. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" numberOfSteps: description: > Number of scaling steps to be executed as part of this Scale VNF operation. It shall be a positive number and the default value shall be 1. type: integer default: 1 additionalParams: description: > Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled, as declared in the VNFD as part of "ScaleVnfOpConfig". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" ScaleVnfToLevelRequest: description: > This type represents request parameters for the "Scale VNF to Level" operation. type: object properties: instantiationLevelId: description: > Identifier of the target instantiation level of the current deployment flavour to which the VNF is requested to be scaled. Either the instantiationLevelId attribute or the scaleInfo attribute shall be included. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" scaleInfo: description: > For each scaling aspect of the current deployment flavour, indicates the target scale level to which the VNF is to be scaled. Either the instantiationLevelId attribute or the scaleInfo attribute shall be included. type: array items: $ref: "#/definitions/ScaleInfo" additionalParams: description: > Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled, as declared in the VNFD as part of "ScaleVnfToLevelOpConfig". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfInfoModificationRequest: description: > This type represents attribute modifications for an "Individual VNF instance" resource, i.e. modifications to a resource representation based on the "VnfInstance" data type. The attributes of "VnfInstance" that can be modified according to the provisions in clause 5.5.2.2 are included in the "VnfInfoModificationRequest" data type. The "VnfInfoModificationRequest" data type shall comply with the provisions defined in table 5.5.2.12-1. type: object properties: vnfInstanceName: description: > New value of the "vnfInstanceName" attribute in "VnfInstance", or "null" to remove the attribute. type: string vnfInstanceDescription: description: > New value of the "vnfInstanceDescription" attribute in "VnfInstance", or "null" to remove the attribute. type: string vnfdId: description: > New value of the "vnfdId" attribute in "VnfInstance". The value "null" is not permitted. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" vnfConfigurableProperties: description: > Modifications of the "vnfConfigurableProperties" attribute in "VnfInstance". If present, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396 [15]). $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" metadata: description: > Modifications of the "metadattametadata" attribute in "VnfInstance". If present, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396 [15]). $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" extensions: description: > Modifications of the "extensions" attribute in "VnfInstance". If present, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396 [15]). $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vnfcInfoModifications: description: > Modifications of certain entries in the "vnfcInfo" attribute array in the "instantiatedVnfInfo" attribute of "VnfInstance"." to be used as "newList" as defined below this table. type: array items: $ref: "#/definitions/VnfcInfoModifications" vnfcInfoModificationsDeleteIds: description: > List of identifiers entries to be deleted from the 'vnfcInfoModifications" attribute array to be used as "deleteIdList" as defined below this table. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" 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. type: object properties: vnfInstanceName: description: > If present, this attribute signals modifications of the "vnfInstanceName" attribute in "VnfInstance". type: string vnfInstanceDescription: description: > If present, this attribute signals modifications of the "vnfInstanceDescription" attribute in "VnfInstance". type: string vnfConfigurableProperties: description: > If present, this attribute signals modifications of the "vnfConfigurableProperties" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" metadata: description: > If present, this attribute signals modifications of the "metadata" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" extensions: description: > If present, this attribute signals modifications of the "extensions" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vnfdId: description: > If present, this attribute signals modifications of the "vnfdId" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" vnfProvider: description: > If present, this attribute signals modifications of the "vnfProvider" attribute in "VnfInstance". If present, this attribute (which depends on the value of the "vnfPkgId" attribute) was modified implicitly following a request to modify the "vnfPkgId" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the "vnfPkgId” attribute. type: string vnfProductName: description: > If present, this attribute signals modifications of the "vnfProductName" attribute in "VnfInstance". If present, this attribute (which depends on the value of the "vnfPkgId" attribute) was modified implicitly following a request to modify the "vnfPkgId" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the "vnfPkgId” attribute. type: string vnfSoftwareVersion: description: > If present, this attribute signals modifications of the "vnfSoftwareVersion" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/Version" vnfdVersion: description: > If present, this attribute signals modifications of the "vnfdVersion" attribute in "VnfInstance". 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. $ref: "SOL002SOL003_def.yaml#/definitions/Version" vnfcInfoModifications: description: > If present, this attribute signals modifications of certain entries in the "vnfcInfo" attribute array in the "instantiatedVnfInfo" attribute of "VnfInstance", as defined in clause 5.5.2.12 type: array items: $ref: "#/definitions/VnfcInfoModifications" vnfcInfoModificationsDeleteIds: description: > If present, this attribute signals the deletion of certain entries in the "vnfcInfo" attribute array in the "instantiatedVnfInfo" attribute of "VnfInstance", as defined in clause 5.5.2.12 type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" VnfLcmOpOcc: description: > This type represents a VNF lifecycle management operation occurrence. type: object required: - id - operationState - stateEnteredTime - startTime - vnfInstanceId - operation - isAutomaticInvocation - isCancelPending properties: id: description: > Identifier of this VNF lifecycle management operation occurrence. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" operationState: description: > The state of the LCM operation. $ref: "#/definitions/LcmOperationStateType" stateEnteredTime: description: > Date-time when the current state has been entered. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" startTime: description: > Date-time of the start of the operation. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" vnfInstanceId: description: > Identifier of the VNF instance to which the operation applies $ref: "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: "SOL002SOL003_def.yaml#/definitions/Identifier" operation: description: > Type of the actual LCM operation represented by this VNF LCM operation occurrence. $ref: "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: "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. 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 This attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource. 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: "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/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: "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. NOTE 1: This allows the NFVO/API consumer to obtain the information contained in the latest "result" notification if it has not received it due to an error or a wrongly configured subscription filter. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/AffectedVnfc" affectedVirtualLinks: description: > Information about VL instances that were affected during the lifecycle operation. See note 1 and note 2. NOTE 1: This allows the NFVO/API consumer 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: 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: array items: $ref: "#/definitions/AffectedVirtualLink" affectedExtLinkPorts: description: > Information about external VNF link ports that were affected during the lifecycle operation. See note 1. NOTE 1: This allows the NFVO/API consumer to obtain the information contained in the latest "result" notification if it has not received it due to an error or a wrongly configured subscription filter. type: array items: $ref: "#/definitions/AffectedExtLinkPort" affectedVirtualStorages: description: > Information about virtualised storage instances that were affected during the lifecycle operation. This allows the NFVO/API consumer to obtain the information contained in the latest "result" notification if it has not received it due to an error or a wrongly configured subscription filter. type: array items: $ref: "#/definitions/AffectedVirtualStorage" changedInfo: description: > Information about the changed VNF instance information, including VNF configurable properties, if applicable. This allows the NFVO/API consumer to obtain the information contained in the latest "result" notification if it has not received it due to an error or a wrongly configured subscription filter. $ref: "#/definitions/VnfInfoModifications" changedExtConnectivity: description: > Information about changed external connectivity, if applicable. This allows the NFVO/API consumer to obtain the information contained in the latest "result" notification if it has not received it due to an error or a wrongly configured subscription filter. type: array items: $ref: "#/definitions/ExtVirtualLinkInfo" _links: description: > Links to resources related to this resource. type: object required: - self - vnfInstance properties: self: description: > URI of this resource. $ref: "SOL002SOL003_def.yaml#/definitions/Link" vnfInstance: description: > Link to the VNF instance that the operation applies to. $ref: "SOL002SOL003_def.yaml#/definitions/Link" grant: description: > Link to the grant for this operation, if one exists. $ref: "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: "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: "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: "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: "SOL002SOL003_def.yaml#/definitions/Link" CancelMode: description: > This type represents a parameter to select the mode of cancelling an ongoing VNF LCM operation occurrence. type: object required: - cancelMode properties: cancelMode: description: > Cancellation mode to apply. $ref: "#/definitions/CancelModeType" LccnSubscriptionRequest: description: > This type represents a subscription request related to notifications about VNF lifecycle changes. type: object required: - callbackUri properties: filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. $ref: "#/definitions/LifecycleChangeNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" LccnSubscription: description: > This type represents a subscription related to notifications about VNF lifecycle changes. type: object required: - id - callbackUri - _links properties: id: description: > Identifier of this subscription resource. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. $ref: "#/definitions/LifecycleChangeNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" _links: description: > Links to resources related to this resource. type: object required: - self properties: self: description: > URI of this resource. $ref: "SOL002SOL003_def.yaml#/definitions/Link" ExtVirtualLinkInfo: type: object required: - id - resourceHandle properties: id: description: > Identifier of the external VL and the related external VL information instance. The identifier is assigned by the NFV-MANO entity that manages this VL instance. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" resourceHandle: description: > Reference to the resource realizing this VL. $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" extLinkPorts: description: > Link ports of this VL. type: array items: $ref: "#/definitions/ExtLinkPortInfo" 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: "SOL002SOL003_def.yaml#/definitions/Identifier" vnfVirtualLinkDescId: description: > Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" networkResource: description: > Reference to the VirtualNetwork resource. $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" vnfLinkPorts: description: > Link ports of this VL. type: array items: $ref: "#/definitions/VnfLinkPortInfo" ScaleInfo: required: - aspectId - scaleLevel type: object properties: aspectId: description: > Identifier of the scaling aspect. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" scaleLevel: description: > Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD. type: integer 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: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfVirtualLinkDescId: description: > Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" networkResource: description: > Reference to the VirtualNetwork resource. $ref: "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: "SOL002SOL003_def.yaml#/definitions/Identifier" reservationId: description: > The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. $ref: "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/VnfLinkPortInfo" metadata: description: > Metadata about this resource. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" 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: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" virtualStorageDescId: description: > Identifier of the VirtualStorageDesc in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" storageResource: description: > Reference to the VirtualStorage resource. $ref: "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: "SOL002SOL003_def.yaml#/definitions/Identifier" reservationId: description: > The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this resource. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfLinkPortInfo: type: object required: - id - resourceHandle properties: id: description: > Identifier of this link port as provided by the entity that has created the link port. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" resourceHandle: description: > Reference to the virtualised resource realizing this link port. $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" cpInstanceId: description: > When the link port is used for external connectivity by the VNF, this attribute represents the identifier of the external CP of the VNF to be connected to this link port. When the link port is used for internal connectivity in the VNF, this attribute represents the identifier of the VNFC CP to be connected to this link port. Shall be present when the link port is used for external connectivity by the VNF. May be present if used to reference a VNFC CP instance. There shall be at most one link port associated with any external connection point instance or internal connection point (i.e. VNFC CP) instance. The value refers to an "extCpInfo" item in the VnfInstance or a "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpInstanceType: description: > Type of the CP instance that is identified by cpInstanceId. Shall be present if "cpInstanceId" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP. type: string enum: - VNFC_CP - EXT_CP ExtLinkPortInfo: description: > This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL. type: object required: - id - resourceHandle properties: id: description: > Identifier of this link port as provided by the entity that has created the link port. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" resourceHandle: description: > Reference to the virtualised resource realizing this link port. $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" cpInstanceId: description: > Identifier of the external CP of the VNF connected to this link port. There shall be at most one link port associated with any external connection point instance. The value refers to an "extCpInfo" item in the VnfInstance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" CpProtocolInfo: description: > This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses. required: - layerProtocol properties: layerProtocol: description: > The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported. type: string enum: - IP_OVER_ETHERNET ipOverEthernet: description: > IP addresses over Ethernet to assign to the extCP instance. Shall be present if layerProtocol is equal to " IP_OVER_ETHERNET", and shall be absent otherwise. $ref: "#/definitions/IpOverEthernetAddressInfo" IpOverEthernetAddressInfo: description: > This type represents information about a network address that has been assigned. type: object properties: macAddress: description: > MAC address, if assigned. At least one of "macAddress" or "ipAddresses" shall be present. $ref: "SOL002SOL003_def.yaml#/definitions/MacAddress" ipAddresses: description: > Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of "macAddress" or "ipAddresses" shall be present. type: array items: type: object required: - type properties: type: description: > The type of the IP addresses. Permitted values: IPV4, IPV6. type: string enum: - IPV4 - IPV6 addresses: description: > Fixed addresses assigned (from the subnet defined by "subnetId" if provided). Exactly one of "addresses" or "addressRange" shall be present. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress" isDynamic: description: > Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if "addresses" is present and shall be absent otherwise. type: boolean addressRange: description: > An IP address range used, e.g., in case of egress connections. Exactly one of "addresses" or "addressRange" shall be present. type: object required: - minAddress - maxAddress properties: minAddress: description: > Lowest IP address belonging to the range. $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress" maxAddress: description: > Highest IP address belonging to the range $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress" subnetId: description: > Subnet defined by the identifier of the subnet resource in the VIM. In case this attribute is present, IP addresses are bound to that subnet. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVim" MonitoringParameter: type: object required: - id - performanceMetric properties: id: description: > Identifier of the monitoring parameter defined in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" name: description: > Human readable name of the monitoring parameter, as defined in the VNFD. type: string performanceMetric: description: > Performance metric that is monitored. This attribute shall contain the related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string LifecycleChangeNotificationsFilter: description: > This type represents a subscription filter related to notifications about VNF lifecycle changes. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). type: object properties: vnfInstanceSubscriptionFilter: description: > Filter criteria to select VNF instances about which to notify. $ref: "SOL002SOL003_def.yaml#/definitions/VnfInstanceSubscriptionFilter" notificationTypes: description: > Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. type: array items: type: string enum: - VnfLcmOperationOccurrenceNotification - VnfIdentifierCreationNotification - VnfIdentifierDeletionNotification operationTypes: description: > Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the "notificationTypes" attribute contains the value "VnfLcmOperationOccurrenceNotification", and shall be absent otherwise. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType" operationStates: description: > Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the "notificationTypes" attribute contains the value "VnfLcmOperationOccurrenceNotification", and shall be absent otherwise. type: array items: $ref: "#/definitions/LcmOperationStateType" AffectedVirtualLink: description: > This type provides information about added, deleted, modified and temporary VLs, and added or removed VNF link ports. It shall comply with the provisions in table 5.5.3.14-1. type: object required: - id - vnfVirtualLinkDescId - changeType - networkResource properties: id: description: > Identifier of the virtual link instance, identifying the applicable "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfVirtualLinkDescId: description: > Identifier of the related VLD in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" 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. 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. $ref: "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. 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". $ref: "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: "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 VnfVirtualLinkResourceInfo structure. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" 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. 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: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" 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: "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: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" AffectedVirtualStorage: description: > This type provides information about added, deleted, modified and temporary virtual storage resources. 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: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" virtualStorageDescId: description: > Identifier of the related VirtualStorage descriptor in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" 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: "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. 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". $ref: "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: "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: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" LccnLinks: description: > This type represents the links to resources that a notification can contain. type: object required: - vnfInstance - subscription properties: vnfInstance: description: > Link to the resource representing the VNF instance to which the notified change applies. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" subscription: description: > Link to the related subscription. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" vnfLcmOpOcc: description: > Link to the VNF lifecycle management operation occurrence that this notification is related to. Shall be present if there is a related lifecycle operation occurrence. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" VnfExtCpInfo: description: > This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1. type: object required: - id - cpdId - cpProtocolInfo properties: id: description: > Identifier of the external CP instance and the related information instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the external CPD, VnfExtCpd, in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" cpProtocolInfo: description: > Network protocol information for this CP. type: array items: $ref: "#/definitions/CpProtocolInfo" extLinkPortId: description: > Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" structure. Shall be present if the CP is associated to a link port. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this external CP. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" associatedVnfcCpId: description: > Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure that represents the VNFC CP which is exposed by this external CP instance. Shall be present in case this CP instance maps to a VNFC CP. See note. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" associatedVnfVirtualLinkId: description: > Identifier of the "VnfVirtualLinkResourceInfo" structure that represents the internal VL which is exposed by this external CP instance. Shall be present in case this CP instance maps to an internal VL. See note. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" VnfOperationalStateType: description: > STARTED: The VNF instance is up and running. STOPPED: The VNF instance has been shut down. type: string enum: - STARTED - STOPPED LcmOperationStateType: description: > STARTING: The LCM operation is starting. PROCESSING: The LCM operation is currently in execution. COMPLETED: The LCM operation has been completed successfully. FAILED_TEMP: The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED: The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK: The LCM operation is currently being rolled back. ROLLED_BACK: The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible. type: string enum: - STARTING - PROCESSING - COMPLETED - FAILED_TEMP - FAILED - ROLLING_BACK - ROLLED_BACK CancelModeType: description: > Cancellation mode. GRACEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or "ROLLING_BACK" state, the VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in "STARTING" state, the VNFM shall not start any resource management operation and shall wait for the granting request to finish execution or time out. After that, the VNFM shall put the operation occurrence into the ROLLED_BACK state. FORCEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or "ROLLING_BACK" state, the VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in "STARTING" state, the VNFM shall not start any resource management operation and put the operation occurrence into the ROLLED_BACK state. type: string enum: - GRACEFUL - FORCEFUL ######################################################################################################################## 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. 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 * 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. 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. See clause 5.6.2.2 for further provisions regarding sending this notification, including in cases of handling LCM operation errors. 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: "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: "SOL002SOL003_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "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: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType" vnfInstanceId: description: > The identifier of the VNF instance affected. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" operation: description: > The lifecycle management operation. $ref: "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 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 associated "Individual VNF lifecycle management operation occurrence" resource. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" affectedVnfcs: description: > Information about VNFC instances that were affected during the lifecycle operation. Shall be present if the "notificationStatus" is set to "RESULT" 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. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/AffectedVnfc" affectedVirtualLinks: description: > Information about VL instances that were affected during the lifecycle operation. NOTE 1: Shall be present if the "notificationStatus" is set to "RESULT" 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: array items: $ref: "#/definitions/AffectedVirtualLink" affectedExtLinkPorts: description: > Information about external VNF link ports that were affected during the lifecycle operation. See note 1. NOTE 1: Shall be present if the "notificationStatus" is set to "RESULT" 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. type: array items: $ref: "#/definitions/AffectedExtLinkPort" affectedVirtualStorages: description: > Information about virtualised storage instances that were affected during the lifecycle operation. Shall be present if the "notificationStatus" is set to "RESULT" 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. 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" and the operation has performed any changes to VNF instance information, including VNF configurable properties. Shall be absent otherwise. $ref: "#/definitions/VnfInfoModifications" 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" 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/ExtVirtualLinkInfo" 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: "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/LccnLinks" VnfIdentifierCreationNotification: description: > This type represents a VNF identifier creation notification, which informs the receiver of the creation of a new "Individual VNF instance" resource and the associated VNF instance identifier. This notification shall be triggered by the VNFM when it has created an "Individual VNF instance" resource and the associated VNF instance identifier. type: object required: - id - notificationType - subscriptionId - timeStamp - vnfInstanceId - _links properties: id: description: > Identifier of the VNF instance. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "VnfIdentifierCreationNotification" for this notification type. type: string enum: - VnfIdentifierCreationNotification subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" vnfInstanceId: description: > The created VNF instance identifier. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" _links: description: > Links to resources related to this notification. $ref: "#/definitions/LccnLinks" VnfIdentifierDeletionNotification: description: > This type represents a VNF identifier deletion notification, which informs the receiver of the deletion of a new "Individual VNF instance" resource and the associated VNF instance identifier. This notification shall be triggered by the VNFM when it has deleted an "Individual VNF instance" resource and the associated VNF instance identifier. type: object required: - id - notificationType - subscriptionId - timeStamp - vnfInstanceId - _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: "SOL002SOL003_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "VnfIdentifierDeletionNotification" for this notification type. type: string enum: - VnfIdentifierDeletionNotification subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" vnfInstanceId: description: > The deleted VNF instance identifier. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" _links: description: > Links to resources related to this notification. $ref: "#/definitions/LccnLinks" VnfcInfoModifications: description: > This type represents modifications of an entry in an array of "VnfcInfo" objects. It shall comply with the provisions defined in table 5.5.3.24-1. type: object required: - id - vnfcConfigurableProperties properties: id: description: > Identifier of the VNFC instance of which the information is to be modified. The identifier references the "id" attribute in a "VnfcInfo" structure. NOTE: The attribute "id" in this data type represents the same identifier as the attribute "vnfcInstanceId" in other related data types in the present document. For reasons of backward compatibility, this misalignment is not corrected. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcConfigurableProperties: description: > Changes of the configurable properties of the VNFC instance. When this structure is part of a request, the modifications signalled in this attribute shall be applied according to the rules of JSON Merge Patch (see IETF RFC 7396). $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfcInfo: description: > This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1. type: object required: - id - vduId - vnfcResourceInfoId - vnfcState properties: id: description: > Identifier of the VNFC instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vduId: description: > Reference to the applicable VDU information element in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcResourceInfoId: description: > Identifier of the VnfcResourceInfo instance representing the virtualised resources used by this VNFC instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcState: description: > Identifier of the VnfcResourceInfo instance representing the virtualised resources used by this VNFC instance. State of the VNFC instance. Permitted values: • STARTED: The VNFC instance is up and running. • STOPPED: The VNFC instance has been shut down type: string enum: - STARTED - STOPPED $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcConfigurableProperties: description: > Current values of the configurable properties of the VNFC instance. Configurable properties referred in this attribute are declared in the VNFD. This attribute can be modified with the PATCH method $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"