resolve minor issues in SOL003 v4.3.1 (9f59382c) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/General_Definitions/SOL003_def.yaml

+38 −35

Original line number	Diff line number	Diff line
		@@ -188,7 +188,7 @@ definitions:
		VimConnectionInfo:
		description: >
		This type represents parameters to connect to a VIM, a CISM, a CIR or a MCIOP repository for managing
		the resources of a VNF instance. It shall comply with the provisions defined in table 4.4.1.6-1.
		the resources of a VNF instance.

		This structure is used to convey VIM-related, CISM-related, CIR-related, or MCIOP-repository-relate
		dparameters over the Or-Vnfm interface. Additional parameters for a VIM, a CISM, a CIR or a MCIOP
		@@ -276,8 +276,7 @@ definitions:
		type: object
		description: >
		This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.
		Information about the resource is available from the VIM. The ResourceHandle type shall comply with the provisions
		defined in table 4.4.1.7-1.
		Information about the resource is available from the VIM.

		* NOTE 1: The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or CISM or the resource
		provider and can be used as information that complements the ResourceHandle. This value set is different from
		@@ -355,12 +354,12 @@ definitions:
		last key from the map removes the affected instance of the "VnfExtCpData" structure from
		its parent data structure.
		* NOTE 4: If, as defined by the input parameters of a "ChangeVnfFlavour", "ChangeExtVnfConnectivity" or
		"ChangeCurrentVnfPkg" operation or as part of the Grant response for any of these operations, a
		cpConfig map entry identified by a particular map key value is moved into another "ExtVirtualLinkData"
		or "VnfExtCpData" structure, this particular cpConfig map entry may be used by an external CP instance
		"ChangeCurrentVnfPkg" operation or as part of the Grant response for any of these operations, a cpConfig
		map entry identified by a particular map key value is moved into another "ExtVirtualLinkData" or
		"VnfExtCpData" structure, this particular cpConfig map entry may be used by an external CP instance
		different than the one that has used it before the operation, or by no external CP instance at all.
		Renaming a CPD identifier during the "changeCurrentVnfPkg" operation does not count as moving the
		related "cpConfig" map entries to a new "extCpData" structure.
		Renaming a CPD identifier during the "changeCurrentVnfPkg" operation does not count as moving the related
		"cpConfig" map entries to a new "extCpData" structure.
		type: object
		required:
		- cpdId
		@@ -433,6 +432,7 @@ definitions:
		in "VnfExtCpConfig" structures that provide configuration information for a CP which represents a sub-port in
		a trunk, and if parent ports are supported.
		$ref: "#/definitions/IdentifierInVnf"

		linkPortId:
		description: >
		Identifier of a pre-configured link port to which the external CP
		@@ -462,6 +462,7 @@ definitions:
		type: array
		items:
		$ref: "#/definitions/Identifier"

		cpProtocolData:
		description: >
		Parameters for configuring the network protocols on the
		@@ -490,6 +491,7 @@ 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
		@@ -617,7 +619,7 @@ definitions:

		VirtualCpAddressData:
		description: >
		This type represents network address data for a virtual CP. It shall comply with the provisions defined in table 4.4.1.10d-1.
		This type represents network address data for a virtual CP.

		* NOTE 1: If the container cluster is set up to be able to configure an external load balancer this address will be used,
		otherwise it will be ignored by the CISM.
		@@ -644,18 +646,18 @@ definitions:

		ExtVirtualLinkData:
		description: >
		This type represents an external VL. It shall comply with the provisions defined in table 4.4.1.11-1.
		This type represents an external VL.

		* NOTE 1: A link port is not needed for an external CP instance that exposes a VIP CP in the following cases:
		1 For a VIP CP directly exposed as an external CP:
		1.1 No dedicated IP address is allocated as VIP address, as indicated in the VNFD.
		1.2 A dedicated IP address is allocated as VIP address, but the NFVO indicates that no port is needed
		1) For a VIP CP directly exposed as an external CP:
		1.1) No dedicated IP address is allocated as VIP address, as indicated in the VNFD.
		1.2) A dedicated IP address is allocated as VIP address, but the NFVO indicates that no port is needed
		(createExtLinkPort in VnfExtCpConfig set to false).
		2 For a VIP CP exposed as an external CP via a floating IP address:
		2.1 No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC CP
		2) For a VIP CP exposed as an external CP via a floating IP address:
		2.1) No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC CP
		associated to the VIP CP is also exposed via a floating IP address.
		3 For a VIRTUAL CP exposed as an external CP.
		4 For a VNFC CP exposed as an external CP in a secondary container cluster external network or a
		3) For a VIRTUAL CP exposed as an external CP.
		4) For a VNFC CP exposed as an external CP in a secondary container cluster external network or a
		secondary container cluster internal network.

		* NOTE 2: An example of the network attachment definition resource when the container infrastructure service
		@@ -751,6 +753,8 @@ definitions:
		description: >
		This type represents additional resource information which resource and resource type
		specific, and which is available from the VIM or the CISM or the resource provider.

		NOTE: At least one attribute shall be present.
		type: object
		properties:
		hostName:
		@@ -964,7 +968,6 @@ definitions:
		VNF lifecycle operation types in VNF lifecycle management operation
		occurrence resources and VNF lifecycle management operation occurrence
		notifications.
		It shall comply with the provisions defined in table 5.5.4.5-1.

		Value \| Description
		------\|------------

src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml

+2 −2

Original line number	Diff line number	Diff line
		@@ -454,7 +454,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.

		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

src/SOL003/VNFIndicator/definitions/SOL003VNFIndicator_def.yaml

+6 −5

Original line number	Diff line number	Diff line
		@@ -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
		@@ -51,7 +51,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.

		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 +152,8 @@ 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 +227,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

src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml

+37 −62

Original line number	Diff line number	Diff line
		@@ -5,7 +5,6 @@ definitions:
		InstantiateVnfRequest:
		description: >
		This type represents request parameters for the "Instantiate VNF" operation.
		It shall comply with the provisions defined in table 5.5.2.4-1.

		* NOTE 1: The indication of externally-managed internal VLs is needed in case
		networks have been pre-configured for use with certain VNFs, for instance
		@@ -200,7 +199,6 @@ 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.

		* 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
		@@ -308,7 +306,6 @@ 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.

		NOTE: If the VNF is still in service, requesting forceful termination can
		adversely impact network service.
		@@ -370,7 +367,6 @@ 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.

		NOTE: The "stopType" and "gracefulStopTimeout" attributes shall be absent,
		when the "changeStateTo" attribute is equal to "STARTED".
		@@ -457,7 +453,6 @@ definitions:
		description: >
		This type represents request parameters for the "Change current VNF package"
		operation to replace the VNF package on which a VNF instance is based.
		It shall comply with the provisions defined in table 5.5.2.11a-1.

		NOTE 1: The indication of externally-managed internal VLs is needed in case networks
		have been pre-configured for use with certain VNFs, for instance to ensure
		@@ -583,8 +578,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
		@@ -673,7 +666,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
		@@ -698,8 +690,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.
		@@ -737,8 +728,7 @@ definitions:
		This type represents attribute modifications for an "Individual VNF snapshot" resource, i.e. modifications
		to a resource representation based on the "VnfSnapshotInfo" data type. The attributes of "VnfSnapshotInfo"
		that can be modified according to the provisions in clause 5.5.2.22 are included in the
		"VnfSnapshotInfoModificationRequest" data type. The "VnfSnapshotInfoModificationRequest" data type shall
		comply with the provisions defined in table 5.5.2.24-1.
		"VnfSnapshotInfoModificationRequest" data type.
		type: object
		properties:
		vnfSnapshotPkgId:
		@@ -757,8 +747,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:
		@@ -774,7 +763,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.
		@@ -1297,7 +1286,6 @@ definitions:
		In addition, the references to the storage resources depend on the form of the VNFC:
		a) For a VNFC based on VM, storage resource identifiers shall refer to VirtualStorage resources, and
		b) For a VNFC based on OS container(s), storage resource identifiers shall refer to Storage MCIOs.
		It shall comply with the provisions defined in table 5.5.3.5-1.

		NOTE 1: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on
		TOSCA specifications.
		@@ -1427,7 +1415,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
		@@ -1491,7 +1478,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
		@@ -1564,7 +1550,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
		@@ -1698,7 +1684,6 @@ 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.

		NOTE: The "resourceDefinitionId" attribute provides information to the API consumer
		(i.e. the NFVO) to assist in correlating the resource changes performed during
		@@ -1799,7 +1784,6 @@ 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.

		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
		@@ -2131,7 +2115,6 @@ 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.

		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
		@@ -2159,6 +2142,7 @@ definitions:
		type: string
		enum:
		- ADDED
		- MODIFIED
		- REMOVED
		extCpInstanceId:
		description: >
		@@ -2179,7 +2163,7 @@ 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
		@@ -2500,7 +2484,6 @@ 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.

		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
		@@ -2595,6 +2578,8 @@ definitions:
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"

		CreateVnfRequest:
		description: >
		This type represents request parameters for the "Create VNF identifier" operation.
		type: object
		required:
		- vnfdId
		@@ -2621,8 +2606,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
		@@ -2661,8 +2645,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.
		@@ -2785,7 +2767,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
		@@ -2833,8 +2815,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
		@@ -2902,7 +2883,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.
		@@ -2945,7 +2926,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
		@@ -2959,12 +2939,13 @@ definitions:
		The identifier of layer(s) and protocol(s) associated to the network address information.

		Permitted values:
		1. IP_OVER_ETHERNET
		2. IP_FOR_VIRTUAL_CP
		- IP_OVER_ETHERNET
		- IP_FOR_VIRTUAL_CP
		See note.
		type: string
		enum:
		- IP_OVER_ETHERNET
		- IP_FOR_VIRTUAL_CP
		ipOverEthernet:
		description: >
		IP addresses over Ethernet to assign to the extCP instance. Shall be
		@@ -2981,7 +2962,6 @@ 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.

		NOTE 1: At least one of "macAddress" or "ipAddresses" shall be present.
		NOTE 2: Exactly one of "addresses" or "addressRange" shall be present.
		@@ -3098,7 +3078,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.

		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
		@@ -3177,7 +3157,6 @@ 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.

		NOTE 1: The attributes "associatedVnfcCpId", "associatedVipCpId", "associatedVirtualCpId" and
		"associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present.
		@@ -3496,7 +3475,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
		@@ -3615,8 +3593,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.
		@@ -3800,8 +3777,7 @@ definitions:

		VirtualCpInfo:
		description: >
		This type provides information related to a virtual CP instance of a VNF. It shall comply with the provisions
		in table 5.5.3.31-1.
		This type provides information related to a virtual CP instance of a VNF.

		NOTE: A consumer of the VNF LCM interface can learn the actual VNFC instances implementing the service
		accessible via the virtual CP instance by querying the "vnfcResourceInfo" from the "InstantiatedVnfInfo"
		@@ -3856,7 +3832,7 @@ definitions:
		AdditionalServiceInfo:
		description: >
		This type provides additional service information of the virtual CP instance used to expose properties of the
		virtual CP to NFV-MANO. It shall comply with the provisions in table 5.5.3.32-1.
		virtual CP to NFV-MANO.

		NOTE: This attribute shall only be present if additional information is needed to identify the service
		termination within the VNF, such as for example a URL path information in an HTTP request required
		@@ -3881,8 +3857,7 @@ definitions:

		ServicePortInfo:
		description: >
		This type describes the service identifying port properties exposed by the virtual CP instance. It shall
		comply with the provisions in table 5.5.3.33-1.
		This type describes the service identifying port properties exposed by the virtual CP instance.
		type: object
		required:
		- name
		@@ -3919,7 +3894,7 @@ definitions:
		description: >
		This type contains information related to a network attachment definition resource that provides the
		specification of the interface used to connect one or multiple connection points to a secondary container
		cluster network. It shall comply with the provisions defined in table 5.5.3.36-1.
		cluster network.
		type: object
		required:
		- netAttDefResourceInfoId

src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml

+4 −6

File changed.

Preview size limit exceeded, changes collapsed.