diff --git a/src/SOL002/General_Definitions/SOL002_def.yaml b/src/SOL002/General_Definitions/SOL002_def.yaml index 87d054d84fb12d3662242fb95b5625d1cf0a34aa..4c8d848ec1800da36a694b0e2b1b9aae06d49f74 100644 --- a/src/SOL002/General_Definitions/SOL002_def.yaml +++ b/src/SOL002/General_Definitions/SOL002_def.yaml @@ -427,7 +427,6 @@ definitions: type: string enum: - IP_OVER_ETHERNET - - IP_FOR_VIRTUAL_CP ipOverEthernet: description: > Network address data for IP over Ethernet to assign to the extCP instance. Shall be diff --git a/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml b/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml index 6ee93cc1ad0538e48088237e18997297405603de..50f20ef77dc33a8833fb7a9d7f2bbcab52e89094 100644 --- a/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml +++ b/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml @@ -4,8 +4,7 @@ definitions: Alarm: description: > - The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in - table 7.5.2.4-1. + The alarm data type encapsulates information about an alarm. If the attribute "faultType" has the value "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE", the following provisions apply for the values of the attribute "faultDetails" related to @@ -310,8 +309,7 @@ definitions: FmNotificationsFilter: description: > - This type represents a subscription filter related to notifications about VNF faults. - It shall comply with the provisions defined in table 7.5.3.2-1. + This type represents a subscription filter related to notifications about VNF faults. 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 diff --git a/src/SOL002/VNFIndicator/definitions/SOL002VNFIndicator_def.yaml b/src/SOL002/VNFIndicator/definitions/SOL002VNFIndicator_def.yaml index bd2ab00c3371d059cc52b65ed27e5626486f2c38..7d4c4154dafbada18630c45c1a73da44723b1294 100644 --- a/src/SOL002/VNFIndicator/definitions/SOL002VNFIndicator_def.yaml +++ b/src/SOL002/VNFIndicator/definitions/SOL002VNFIndicator_def.yaml @@ -4,7 +4,7 @@ definitions: VnfIndicator: description: > - This type represents a VNF indicator value. It shall comply with the provisions defined in table 8.5.2.2-1. + This type represents a VNF indicator value. NOTE: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. type: object @@ -50,8 +50,7 @@ definitions: VnfIndicatorNotificationsFilter: description: > - This type represents a subscription filter for notifications related to VNF indicators. - It shall comply with the provisions defined in table 8.5.3.2-1. + This type represents a subscription filter for notifications related to VNF indicators. 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 diff --git a/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml b/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml index cf01a1647965da90442d5bce62cdef730a402f38..def2b90635af4813e3508f89db221f845fffe0a1 100644 --- a/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml +++ b/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml @@ -1013,6 +1013,8 @@ definitions: $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVim" ExtManagedVirtualLinkInfo: + description: > + This type represents an externally-managed internal VL. type: object required: - id @@ -1813,6 +1815,7 @@ definitions: type: string enum: - ADDED + - MODIFIED - REMOVED extCpInstanceId: description: > @@ -1901,6 +1904,8 @@ definitions: $ref: "#/definitions/VnfcInfoModifications" CreateVnfRequest: + description: > + This type represents request parameters for the "Create VNF identifier" operation. type: object required: - vnfdId @@ -1927,8 +1932,7 @@ definitions: ScaleVnfRequest: description: > - This type represents request parameters for the "Scale VNF" operation. It shall comply with the provisions defined in - table 5.5.2.5-1. See clause B.2 in annex B for an explanation of VNF scaling. + This type represents request parameters for the "Scale VNF" operation. type: object required: - type @@ -1967,7 +1971,6 @@ definitions: ScaleVnfToLevelRequest: description: > This type represents request parameters for the "Scale VNF to Level" operation. - It shall comply with the provisions defined in table 5.5.2.6-1. See clause B.2 for an explanation of VNF scaling. NOTE: Either the instantiationLevelId attribute or the scaleInfo attribute shall @@ -2091,7 +2094,7 @@ definitions: ExtVirtualLinkInfo: description: > - This type represents information about an external VL. It shall comply with the provisions defined in table 5.5.3.2-1. + This type represents information about an external VL. NOTE: This attribute reflects the current configuration information that has resulted from merging into this attribute the "VnfExtCpData" information which was passed as part of the "ExtVirtualLinkData" structure in the input of the @@ -2132,8 +2135,7 @@ definitions: VnfLinkPortInfo: description: > - This type represents a link port of an internal VL of a VNF. It shall comply with the provisions - defined in table 5.5.3.8 1. + This type represents a link port of an internal VL of a VNF. NOTE 1: Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be @@ -2201,7 +2203,7 @@ definitions: 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. It shall comply with the provisions defined in table 5.5.3.9-1. + an NS VL. NOTE 1: The use cases UC#4 and UC#5 in clause A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration. NOTE 2: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. @@ -2244,7 +2246,6 @@ definitions: CpProtocolInfo: description: > This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses. - It shall comply with the provisions defined in table 5.5.3.9b-1. NOTE: 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 @@ -2270,8 +2271,7 @@ definitions: IpOverEthernetAddressInfo: description: > - This type represents information about a network address that has been assigned. - It shall comply with the provisions defined in table 5.5.3.10-1. + This type represents information about a network address that has been assigned. NOTE 1: At least one of "macAddress" or "ipAddresses" shall be present. NOTE 2: Exactly one of "addresses" or "addressRange" shall be present. @@ -2387,8 +2387,7 @@ definitions: LifecycleChangeNotificationsFilter: description: > - This type represents a subscription filter related to notifications about VNF lifecycle changes. - It shall comply with the provisions defined in table 5.5.3.12-1. + 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 @@ -2466,8 +2465,7 @@ definitions: 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.17 1. + This type represents information about an external CP of a VNF. NOTE 1: The attributes "associatedVnfcCpId", "associatedVipCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present. @@ -2678,7 +2676,6 @@ definitions: when changing the current VNF package. The attributes that can be included consist of those requested to be modified explicitly in the "ChangeCurrentVnfPkgRequest" data structure, and additional attributes of the "VnfInstance" data structure that were modified implicitly during the operation. - The "ModificationsTriggeredByVnfPkgChange" data type shall comply with the provisions defined in table 5.5.3.21-1. NOTE 1: This attribute represents the delta (semantics as per IETF RFC 7396, JSON Merge Patch) between the value of the attribute at the start of the "Change current VNF package" operation and the value of the attribute @@ -2788,8 +2785,7 @@ definitions: VipCpInfo: description: > - This type provides information related to virtual IP (VIP) CP. It shall comply with the provisions - defined in table 5.5.3.28-1. + This type provides information related to virtual IP (VIP) CP. NOTE 1: It is possible that there is no associated VnfcCp because the VIP CP is available but not associated yet. diff --git a/src/SOL002/VNFPerformanceManagement/definitions/SOL002VNFPerformanceManagement_def.yaml b/src/SOL002/VNFPerformanceManagement/definitions/SOL002VNFPerformanceManagement_def.yaml index b457282f602e1904eec0bb60fa3eda3b00e1435a..8ea5be12dc1823f2e5ee9d13812e185af7a434ac 100644 --- a/src/SOL002/VNFPerformanceManagement/definitions/SOL002VNFPerformanceManagement_def.yaml +++ b/src/SOL002/VNFPerformanceManagement/definitions/SOL002VNFPerformanceManagement_def.yaml @@ -109,7 +109,7 @@ definitions: PerformanceReport: description: > This type defines the format of a performance report provided by the VNFM to the NFVO as a result of collecting - performance information as part of a PM job. The type shall comply with the provisions defined in table 6.5.2.10-1. + performance information as part of a PM job. NOTE: The sub-object allows to structure the measured object but is not to be confused with sub-counters which allow to structure the measurement value. @@ -289,7 +289,7 @@ definitions: PmJobModifications: description: > - This type represents modifications to a PM job. It shall comply with the provisions defined in table 6.5.2.12-1. + This type represents modifications to a PM job. NOTE: At least one of the attributes defined in this type shall be present in request bodies. type: object @@ -314,7 +314,7 @@ definitions: PmJobCriteria: description: > - This type represents collection criteria for PM jobs. It shall comply with the provisions defined in table 6.5.3.3-1. + This type represents collection criteria for PM jobs. NOTE 1: At the end of each reportingPeriod, the API producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. @@ -438,7 +438,7 @@ definitions: ThresholdModifications: description: > - This type represents modifications to a threshold. It shall comply with the provisions defined in table 6.5.2.11-1. + This type represents modifications to a threshold. NOTE: At least one of the attributes defined in this type shall be present in request bodies. type: object @@ -462,7 +462,7 @@ definitions: ThresholdCriteria: description: > - This type represents criteria that define a threshold. It shall comply with the provisions defined in table 6.5.3.4-1. + This type represents criteria that define a threshold. NOTE 1: In the present document, simple thresholds are defined. The definition of additional threshold types is left for future specification. diff --git a/src/SOL002/VNFPerformanceManagementNotification/definitions/SOL002VNFPerformanceManagementNotification_def.yaml b/src/SOL002/VNFPerformanceManagementNotification/definitions/SOL002VNFPerformanceManagementNotification_def.yaml index 3fafae2005ebea84ffffd1721bc2a303effe11d1..c03b7b9d21831e55b5b123b3ca1fade5bed74c6b 100644 --- a/src/SOL002/VNFPerformanceManagementNotification/definitions/SOL002VNFPerformanceManagementNotification_def.yaml +++ b/src/SOL002/VNFPerformanceManagementNotification/definitions/SOL002VNFPerformanceManagementNotification_def.yaml @@ -92,8 +92,7 @@ definitions: ThresholdCrossedNotification: description: > - This type represents a notification that is sent when a threshold has been crossed. - It shall comply with the provisions defined in table 6.5.2.4-1. + This type represents a notification that is sent when a threshold has been crossed. NOTE: The timing of sending this notification is determined by the capability of the producing entity to evaluate the threshold crossing condition. diff --git a/src/SOL003/General_Definitions/SOL003_def.yaml b/src/SOL003/General_Definitions/SOL003_def.yaml index e20b1a6d5173d161ad3718543e3a267a5b1dacba..ff668eef90b20d70fba2c5fd8fdc0ecbed23055e 100644 --- a/src/SOL003/General_Definitions/SOL003_def.yaml +++ b/src/SOL003/General_Definitions/SOL003_def.yaml @@ -407,7 +407,6 @@ definitions: type: string enum: - IP_OVER_ETHERNET - - IP_FOR_VIRTUAL_CP ipOverEthernet: description: > Network address data for IP over Ethernet to assign to the external CP diff --git a/src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml b/src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml index 4b1a39cc48477c2d17882d0afc85ae006d43b267..f322e0d8867b2b947721f66c3e9a298a2ba20088 100644 --- a/src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml +++ b/src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml @@ -284,8 +284,7 @@ definitions: FmNotificationsFilter: description: > - This type represents a subscription filter related to notifications about VNF faults. - It shall comply with the provisions defined in table 7.5.3.2-1. + This type represents a subscription filter related to notifications about VNF faults. 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 diff --git a/src/SOL003/VNFIndicator/definitions/SOL003VNFIndicator_def.yaml b/src/SOL003/VNFIndicator/definitions/SOL003VNFIndicator_def.yaml index 887a492dfb03bbe76d479cd138bc51e09266acda..5ad57db1261e8b4c4ba1e602e324d12be9501852 100644 --- a/src/SOL003/VNFIndicator/definitions/SOL003VNFIndicator_def.yaml +++ b/src/SOL003/VNFIndicator/definitions/SOL003VNFIndicator_def.yaml @@ -4,7 +4,7 @@ definitions: VnfIndicator: description: > - This type represents a VNF indicator value. It shall comply with the provisions defined in table 8.5.2.2-1. + This type represents a VNF indicator value. NOTE: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. type: object @@ -50,8 +50,7 @@ definitions: VnfIndicatorNotificationsFilter: description: > - This type represents a subscription filter for notifications related to VNF indicators. - It shall comply with the provisions defined in table 8.5.3.2-1. + This type represents a subscription filter for notifications related to VNF indicators. 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 @@ -152,7 +151,7 @@ definitions: VnfIndicatorValueChangeNotification: description: > - This type represents a VNF indicator value change notification. It shall comply with the provisions defined in table 8.5.2.5-1. + This type represents a VNF indicator value change notification. The notification shall be triggered by the VNFM when the value of an indicator has changed. NOTE: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. @@ -226,7 +225,7 @@ definitions: SupportedIndicatorsChangeNotification: description: > This type represents a notification to inform the receiver that the set of indicators supported - by a VNF instance has changed. It shall comply with the provisions defined in table 8.5.2.6-1. + by a VNF instance has changed. The notification shall be triggered by the VNFM when the set of supported VNF indicators has changed as a side effect of the "Change current VNF package" operation. It may be triggered by the VNFM when diff --git a/src/SOL003/VNFIndicatorNotification/definitions/SOL003VNFIndicatorNotification_def.yaml b/src/SOL003/VNFIndicatorNotification/definitions/SOL003VNFIndicatorNotification_def.yaml index aa004ddb518e068c080648af2add81404250d55f..0346e79272bce0499b266ee78ab1b99a0add28ff 100644 --- a/src/SOL003/VNFIndicatorNotification/definitions/SOL003VNFIndicatorNotification_def.yaml +++ b/src/SOL003/VNFIndicatorNotification/definitions/SOL003VNFIndicatorNotification_def.yaml @@ -4,7 +4,7 @@ definitions: VnfIndicatorValueChangeNotification: description: > - This type represents a VNF indicator value change notification. It shall comply with the provisions defined in table 8.5.2.5-1. + This type represents a VNF indicator value change notification. The notification shall be triggered by the VNFM when the value of an indicator has changed. NOTE: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. @@ -78,7 +78,7 @@ definitions: SupportedIndicatorsChangeNotification: description: > This type represents a notification to inform the receiver that the set of indicators supported - by a VNF instance has changed. It shall comply with the provisions defined in table 8.5.2.6-1. + by a VNF instance has changed. The notification shall be triggered by the VNFM when the set of supported VNF indicators has changed as a side effect of the "Change current VNF package" operation. It may be triggered by the VNFM when diff --git a/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml b/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml index 387e8c056bd6bcae7e992c23e1f45a8745301813..da89522201100519224c349ea94f84a5145ead39 100644 --- a/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml +++ b/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml @@ -4,8 +4,7 @@ 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. + This type represents request parameters for the "Instantiate VNF" operation. 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 @@ -140,8 +139,7 @@ definitions: 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. + This type represents request parameters for the "Change VNF flavour" operation. 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 @@ -219,8 +217,7 @@ definitions: 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. + This type represents request parameters for the "Terminate VNF" operation. NOTE: If the VNF is still in service, requesting forceful termination can adversely impact network service. @@ -281,8 +278,7 @@ definitions: 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. + This type represents request parameters for the "Operate VNF" operation. NOTE: The "stopType" and "gracefulStopTimeout" attributes shall be absent, when the "changeStateTo" attribute is equal to "STARTED". @@ -362,8 +358,7 @@ definitions: 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. + operation to replace the VNF package on which a VNF instance is based. 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 @@ -490,8 +485,6 @@ definitions: 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 @@ -580,7 +573,6 @@ definitions: 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 @@ -605,8 +597,7 @@ definitions: 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. + LCM operation or extracted from a VNF snapshot package. 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. @@ -664,8 +655,7 @@ definitions: 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. + "VnfSnapshotInfo" data structure that were modified implicitly. type: object properties: vnfSnapshotPkgId: @@ -681,7 +671,7 @@ definitions: VnfInstance: description: > - This type represents a VNF instance. It shall comply with the provisions defined in table 5.5.2.2-1. + This type represents a VNF instance. 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. @@ -720,6 +710,7 @@ definitions: - vnfSoftwareVersion - vnfdVersion - instantiationState + - _links properties: id: description: > @@ -818,6 +809,7 @@ definitions: required: - flavourId - vnfState + - extCpInfo properties: flavourId: description: > @@ -1133,8 +1125,7 @@ definitions: 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. + used by a VNFC in a VNF instance. NOTE 1: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. @@ -1248,7 +1239,6 @@ definitions: 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 @@ -1312,7 +1302,6 @@ definitions: 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 @@ -1385,7 +1374,7 @@ definitions: VnfcSnapshotInfo: description: > - This type represents a VNFC snapshot. It shall comply with the provisions defined in table 5.5.3.19-1. + This type represents a VNFC snapshot. 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 @@ -1518,8 +1507,7 @@ definitions: 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. + This type provides information about added, deleted, modified and temporary VNFCs. NOTE: The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in correlating the resource changes performed during @@ -1619,8 +1607,7 @@ definitions: 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. + This type represents a VNF lifecycle management operation occurrence. 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 @@ -1951,8 +1938,7 @@ definitions: 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. + This type provides information about added and deleted external link ports (link ports attached to external virtual links). 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 @@ -1980,6 +1966,7 @@ definitions: type: string enum: - ADDED + - MODIFIED - REMOVED extCpInstanceId: description: > @@ -2091,8 +2078,7 @@ definitions: 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. + This type provides information about added, deleted, modified and temporary virtual storage resources. 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 @@ -2160,6 +2146,8 @@ definitions: $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs" CreateVnfRequest: + description: > + This type represents request parameters for the "Create VNF identifier" operation. type: object required: - vnfdId @@ -2225,6 +2213,8 @@ definitions: - FORCEFUL ScaleVnfRequest: + description: > + This type represents request parameters for the "Scale VNF" operation. type: object required: - type @@ -2263,8 +2253,6 @@ definitions: ScaleVnfToLevelRequest: description: > This type represents request parameters for the "Scale VNF to Level" operation. - It shall comply with the provisions defined in table 5.5.2.6-1. See clause B.2 - for an explanation of VNF scaling. NOTE: Either the instantiationLevelId attribute or the scaleInfo attribute shall be included. @@ -2333,7 +2321,6 @@ definitions: LifecycleChangeNotificationsFilter: description: > This type represents a subscription filter related to notifications about VNF lifecycle changes. - It shall comply with the provisions defined in table 5.5.3.12-1. 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 @@ -2471,8 +2458,7 @@ definitions: 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.17 1. + This type represents information about an external CP of a VNF. NOTE 1: The attributes "associatedVnfcCpId", "associatedVipCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present. @@ -2548,8 +2534,7 @@ definitions: CpProtocolInfo: description: > - This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses. - It shall comply with the provisions defined in table 5.5.3.9b-1. + This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses. NOTE: 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 @@ -2576,8 +2561,7 @@ definitions: IpOverEthernetAddressInfo: description: > - This type represents information about a network address that has been assigned. - It shall comply with the provisions defined in table 5.5.3.10-1. + This type represents information about a network address that has been assigned. NOTE 1: At least one of "macAddress" or "ipAddresses" shall be present. NOTE 2: Exactly one of "addresses" or "addressRange" shall be present. @@ -2666,8 +2650,7 @@ definitions: VipCpInfo: description: > - This type provides information related to virtual IP (VIP) CP. It shall comply with the provisions - defined in table 5.5.3.28-1. + This type provides information related to virtual IP (VIP) CP. NOTE 1: It is possible that there is no associated VnfcCp because the VIP CP is available but not associated yet. @@ -2726,7 +2709,7 @@ definitions: ExtVirtualLinkInfo: description: > - This type represents information about an external VL. It shall comply with the provisions defined in table 5.5.3.2-1. + This type represents information about an external VL. NOTE: This attribute reflects the current configuration information that has resulted from merging into this attribute the "VnfExtCpData" information which was passed as part of the "ExtVirtualLinkData" structure in the input of the @@ -2768,7 +2751,7 @@ definitions: 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. It shall comply with the provisions defined in table 5.5.3.9-1. + an NS VL. NOTE 1: The use cases UC#4 and UC#5 in clause A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration. NOTE 2: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. @@ -2837,8 +2820,7 @@ definitions: VnfLinkPortInfo: description: > - This type represents a link port of an internal VL of a VNF. It shall comply with the provisions - defined in table 5.5.3.8 1. + This type represents a link port of an internal VL of a VNF. NOTE 1: Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be @@ -2949,7 +2931,6 @@ definitions: when changing the current VNF package. The attributes that can be included consist of those requested to be modified explicitly in the "ChangeCurrentVnfPkgRequest" data structure, and additional attributes of the "VnfInstance" data structure that were modified implicitly during the operation. - The "ModificationsTriggeredByVnfPkgChange" data type shall comply with the provisions defined in table 5.5.3.21-1. NOTE 1: This attribute represents the delta (semantics as per IETF RFC 7396, JSON Merge Patch) between the value of the attribute at the start of the "Change current VNF package" operation and the value of the attribute diff --git a/src/SOL003/VNFLifecycleManagementNotification/definitions/SOL003VNFLifecycleManagementNotification_def.yaml b/src/SOL003/VNFLifecycleManagementNotification/definitions/SOL003VNFLifecycleManagementNotification_def.yaml index 4888c0170a0ecbf6ab5c70bb20490cec95ad8f8f..51926089c2a286fc372a8a4479c3695f0ed4c260 100644 --- a/src/SOL003/VNFLifecycleManagementNotification/definitions/SOL003VNFLifecycleManagementNotification_def.yaml +++ b/src/SOL003/VNFLifecycleManagementNotification/definitions/SOL003VNFLifecycleManagementNotification_def.yaml @@ -96,7 +96,6 @@ definitions: 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 diff --git a/src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml b/src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml index 892a2baca2f5c77346ed6df98a4e27dbc0ec62fb..67958e16fab04501ff75d9baf5139628244d7c76 100644 --- a/src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml +++ b/src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml @@ -4,7 +4,7 @@ definitions: GrantRequest: description: > - This type represents a grant request. It shall comply with the provisions defined in table 9.5.2.2-1. + This type represents a grant request. NOTE 1: The VNF LCM operations CreateVnfIdentifier, DeleteVnfIdentifier, QueryVnf and ModifyVnfInformation can be executed by the VNFM without requesting granting. @@ -87,9 +87,9 @@ definitions: type: boolean instantiationLevelId: description: > - If operation=INSTANTIATE, the identifier of the instantiation level may be provided as an - alternative way to define the resources to be added. This attribute shall only be used if - operation=INSTANTIATE. See note 2. + If operation=INSTANTIATE, the identifier of the instantiation level may be provided as an + alternative way to define the resources to be added. This attribute shall only be used if + operation=INSTANTIATE. See note 2. $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier" addResources: description: > @@ -383,8 +383,7 @@ definitions: ResourceDefinition: description: > - This type provides information of an existing or proposed resource used by the VNF. - It shall comply with the provisions defined in table 9.5.3.2-1. + This type provides information of an existing or proposed resource used by the VNF. NOTE 1: The use cases UC#4 and UC#5 in Annex A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration. @@ -398,6 +397,7 @@ definitions: required: - id - type + - resourceTemplateId properties: id: description: > @@ -804,8 +804,7 @@ definitions: SnapshotResourceDefinition: description: > - This type represents resource definition information related to a snapshot resource. - It shall comply with the provisions defined in table 9.5.3.11-1. + This type represents resource definition information related to a snapshot resource. NOTE 1: If present, the value of the "vduId" (for a related VDU) in the "VnfcResourceInfo" referred by the "vnfcInfoId" of the "VnfcSnapshotInfo" shall match the value of the diff --git a/src/SOL003/VNFPackageManagement/definitions/SOL003VNFPackageManagement_def.yaml b/src/SOL003/VNFPackageManagement/definitions/SOL003VNFPackageManagement_def.yaml index de13c88138116b3dbbb5f04c1217f700ee33d09d..8402a141f6f56fbae9385380805bd79ad155a861 100644 --- a/src/SOL003/VNFPackageManagement/definitions/SOL003VNFPackageManagement_def.yaml +++ b/src/SOL003/VNFPackageManagement/definitions/SOL003VNFPackageManagement_def.yaml @@ -4,7 +4,7 @@ definitions: VnfPkgInfo: description: > - This type represents the information of a VNF package. It shall comply with the provisions defined in table 10.5.2.2-1. + This type represents the information of a VNF package. NOTE 1: If the value of the onboardingState attribute is not equal to "ONBOARDED", the value of the operationalState attribute shall be equal to "DISABLED". @@ -14,6 +14,7 @@ definitions: type: object required: - id + - onboardingState - operationalState - usageState - _links @@ -229,8 +230,7 @@ definitions: VnfPackageSoftwareImageInfo: description: > - This type represents an artifact contained in or external to a VNF package which represents a software image. - It shall comply with the provisions defined in table 10.5.3.2-1. + This type represents an artifact contained in or external to a VNF package which represents a software image. NOTE 1: The list of permitted values was taken from "Container formats" in OpenStack® documentation: "Disk and container formats for images" (Available at https://docs.openstack.org/glance/pike/user/formats.html). @@ -460,8 +460,7 @@ definitions: PkgmNotificationsFilter: description: > - This type represents a subscription filter related to notifications related to VNF package management. - It shall comply with the provisions defined in table 10.5.3.4-1. + This type represents a subscription filter related to notifications related to VNF package management. 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" diff --git a/src/SOL003/VNFPerformanceManagement/definitions/SOL003VNFPerformanceManagement_def.yaml b/src/SOL003/VNFPerformanceManagement/definitions/SOL003VNFPerformanceManagement_def.yaml index 5de311d374a4e6ad558234a277fa857169dc4524..2a52cab1d2bc9a1cdf0b14611f2558439ef8a872 100644 --- a/src/SOL003/VNFPerformanceManagement/definitions/SOL003VNFPerformanceManagement_def.yaml +++ b/src/SOL003/VNFPerformanceManagement/definitions/SOL003VNFPerformanceManagement_def.yaml @@ -109,7 +109,7 @@ definitions: PerformanceReport: description: > This type defines the format of a performance report provided by the VNFM to the NFVO as a result of collecting - performance information as part of a PM job. The type shall comply with the provisions defined in table 6.5.2.10-1. + performance information as part of a PM job. NOTE: The sub-object allows to structure the measured object but is not to be confused with sub-counters which allow to structure the measurement value. @@ -289,7 +289,7 @@ definitions: PmJobModifications: description: > - This type represents modifications to a PM job. It shall comply with the provisions defined in table 6.5.2.12-1. + This type represents modifications to a PM job. NOTE: At least one of the attributes defined in this type shall be present in request bodies. type: object @@ -314,7 +314,7 @@ definitions: PmJobCriteria: description: > - This type represents collection criteria for PM jobs. It shall comply with the provisions defined in table 6.5.3.3-1. + This type represents collection criteria for PM jobs. NOTE 1: At the end of each reportingPeriod, the API producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. @@ -438,7 +438,7 @@ definitions: ThresholdModifications: description: > - This type represents modifications to a threshold. It shall comply with the provisions defined in table 6.5.2.11-1. + This type represents modifications to a threshold. NOTE: At least one of the attributes defined in this type shall be present in request bodies. type: object @@ -462,7 +462,7 @@ definitions: ThresholdCriteria: description: > - This type represents criteria that define a threshold. It shall comply with the provisions defined in table 6.5.3.4-1. + This type represents criteria that define a threshold. NOTE 1: In the present document, simple thresholds are defined. The definition of additional threshold types is left for future specification. diff --git a/src/SOL003/VNFPerformanceManagementNotification/definitions/SOL003VNFPerformanceManagementNotification_def.yaml b/src/SOL003/VNFPerformanceManagementNotification/definitions/SOL003VNFPerformanceManagementNotification_def.yaml index 22f4f6946541141d80ca43815569c89d026802dc..c017f62074ac628ec7586b7e92fc5bebde4db6eb 100644 --- a/src/SOL003/VNFPerformanceManagementNotification/definitions/SOL003VNFPerformanceManagementNotification_def.yaml +++ b/src/SOL003/VNFPerformanceManagementNotification/definitions/SOL003VNFPerformanceManagementNotification_def.yaml @@ -98,8 +98,7 @@ definitions: ThresholdCrossedNotification: description: > - This type represents a notification that is sent when a threshold has been crossed. - It shall comply with the provisions defined in table 6.5.2.4-1. + This type represents a notification that is sent when a threshold has been crossed. NOTE: The timing of sending this notification is determined by the capability of the producing entity to evaluate the threshold crossing condition. diff --git a/src/SOL003/VNFSnapshotPackageManagement/definitions/SOL003VNFSnapshotPackageManagement_def.yaml b/src/SOL003/VNFSnapshotPackageManagement/definitions/SOL003VNFSnapshotPackageManagement_def.yaml index 3b205586f34f965f1cc51d351d7c0e8e47626dcb..7c6c1e955b195f8954347c8f7b80749a4453dab9 100644 --- a/src/SOL003/VNFSnapshotPackageManagement/definitions/SOL003VNFSnapshotPackageManagement_def.yaml +++ b/src/SOL003/VNFSnapshotPackageManagement/definitions/SOL003VNFSnapshotPackageManagement_def.yaml @@ -4,7 +4,7 @@ definitions: VnfSnapshotPkgInfo: description: > - This type represents the information of a VNF snapshot package. It shall comply with the provisions defined in table 12.5.2.2-1. + This type represents the information of a VNF snapshot package. NOTE: The attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector. @@ -178,8 +178,7 @@ definitions: VnfcSnapshotImageInfo: description: > - This type represents an artifact contained in a VNF snapshot package which represents a snapshot image. - It shall comply with the provisions defined in table 12.5.3.2-1. + This type represents an artifact contained in a VNF snapshot package which represents a snapshot image. NOTE 1: The list of permitted values was taken from "Container formats" in OpenStack® documentation: "Disk and container formats for images" (Available at https://docs.openstack.org/glance/pike/user/formats.html).