SOL005_111 to SOL005_119 (9f1fc39f) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NFVICapacityInformation/definitions/NFVICapacityInformation_def.yaml

+25 −15

Original line number	Original line	Diff line number	Diff line
	@@ -37,6 +37,10 @@ components:
	type: object		type: object
	description: \|		description: \|
	This type represents a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1.		This type represents a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1.
			NOTE 1: The "objectInstanceId" aims to identify the "Individual VIM's NFVI capacity information", which is
			associated to a VIM instance.
			NOTE 2: The "subObjectInstanceIds" aim to identify the resource zones in which the available NFVI capacity
			crosses a threshold value.
	required:		required:
	- id		- id
	- objectInstanceId		- objectInstanceId
	@@ -50,12 +54,13 @@ components:
	$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier		$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier
	objectInstanceId:		objectInstanceId:
	description: \|		description: \|
	Identifier of the VIM instance associated with the capacity threshold.		Identifier of the VIM instance associated with the capacity threshold. See note 1.
	$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier		$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier
	subObjectInstanceIds:		subObjectInstanceIds:
	description: \|		description: \|
	Identifiers of the sub-object instances of the measured object instance associate with this capacity threshold.		Identifiers of the sub-object instances of the measured object instance associate with this capacity threshold.
	If this attribute is absent, measurements are taken for all sub-object instances of the measured object instance.		If this attribute is absent, measurements are taken for all sub-object instances of the measured object instance.
			See note 2.
	type: array		type: array
	items:		items:
	$ref: ../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim		$ref: ../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim
	@@ -124,6 +129,12 @@ components:
	description: \|		description: \|
	This type represents criteria that define a capacity threshold.		This type represents criteria that define a capacity threshold.
	It shall comply with the provisions defined in table 10.5.3.3-1.		It shall comply with the provisions defined in table 10.5.3.3-1.
			NOTE 1: In the present document, simple thresholds are defined.
			The definition of additional threshold types is left for future specification.
			NOTE 2: The hysteresis is defined to prevent storms of threshold crossing
			notifications. When processing a request to create a threshold, implementations
			should enforce a suitable minimum value for this attribute (e.g. override the
			value or reject the request).
	required:		required:
	- capacityMetric		- capacityMetric
	- thresholdType		- thresholdType
	@@ -165,8 +176,7 @@ components:
	Type of capacity threshold. This attribute determines which other attributes are present in the data structure.		Type of capacity threshold. This attribute determines which other attributes are present in the data structure.
	Permitted values:		Permitted values:
	- SIMPLE: Single-valued static threshold.		- SIMPLE: Single-valued static threshold.
	In the present document, simple thresholds are defined. The definition of additional threshold types is left		See note 1.
	for future specification.
	type: string		type: string
	enum:		enum:
	- SIMPLE		- SIMPLE
	@@ -191,9 +201,7 @@ components:
	A notification with crossing direction "UP" will be generated if the measured value reaches or		A notification with crossing direction "UP" will be generated if the measured value reaches or
	exceeds "thresholdValue" + "hysteresis". A notification with crossing direction "DOWN" will be		exceeds "thresholdValue" + "hysteresis". A notification with crossing direction "DOWN" will be
	generated if the measured value reaches or undercuts "thresholdValue" - "hysteresis".		generated if the measured value reaches or undercuts "thresholdValue" - "hysteresis".
	The hysteresis is defined to prevent storms of threshold crossing notifications.		See note 2.
	When processing a request to create a threshold, implementations should enforce a suitable minimum
	value for this attribute (e.g. override the value or reject the request).
	type: number		type: number

	NfviCapacityInfoPerZone:		NfviCapacityInfoPerZone:
	@@ -219,21 +227,20 @@ components:
	type: object		type: object
	description: \|		description: \|
	This type defines the format of a time interval. The type shall comply with the provisions defined in table 10.5.2.7-1.		This type defines the format of a time interval. The type shall comply with the provisions defined in table 10.5.2.7-1.
			NOTE: When only the startTime is present, there is no time interval being defined, and therefore the provided timing
			information refers to a specific point in time.
	required:		required:
	- aTime		- aTime
	properties:		properties:
	aTime:		aTime:
	description: \|		description: \|
	First date and time of the interval.		First date and time of the interval. See note.
	When only the startTime is present, there is no time interval being defined, and therefore the provided timing
	information refers to a specific point in time.
	$ref: ../../definitions/SOL005_def.yaml#/definitions/DateTime		$ref: ../../definitions/SOL005_def.yaml#/definitions/DateTime
	bTime:		bTime:
	description: \|		description: \|
	Second date and time of the interval. Shall be present when a time interval is provided, and absent otherwise.		Second date and time of the interval. Shall be present when a time interval is provided, and absent otherwise.
	When provided, the bTime shall be greater than aTime.		When provided, the bTime shall be greater than aTime.
	When only the startTime is present, there is no time interval being defined, and therefore the provided timing		See note.
	information refers to a specific point in time.
	$ref: ../../definitions/SOL005_def.yaml#/definitions/DateTime		$ref: ../../definitions/SOL005_def.yaml#/definitions/DateTime

	NfviCapacityMeasurement:		NfviCapacityMeasurement:
	@@ -241,6 +248,8 @@ components:
	description: \|		description: \|
	This type defines the format of the NFVI capacity information on a per resource type basis.		This type defines the format of the NFVI capacity information on a per resource type basis.
	The type shall comply with the provisions defined in table 10.5.2.6-1.		The type shall comply with the provisions defined in table 10.5.2.6-1.
			NOTE: The present document and referred documents do not specify the capacity measurements,
			thus the capacity measurement names are not specified in the present document version.
	required:		required:
	- resourceType		- resourceType
	- capacityMeasurementName		- capacityMeasurementName
	@@ -256,8 +265,7 @@ components:
	description: \|		description: \|
	Name of the capacity measurement. Different resource types can have different associated capacity measurements,		Name of the capacity measurement. Different resource types can have different associated capacity measurements,
	typically associated to different sub-types of the resource type.		typically associated to different sub-types of the resource type.
	The present document and referred documents do not specify the capacity measurements, thus the capacity		See note.
	measurement names are not specified in the present document version.
	type: string		type: string
	totalCapacity:		totalCapacity:
	description: \|		description: \|
	@@ -294,17 +302,19 @@ components:
	CapacityThresholdModifications:		CapacityThresholdModifications:
	description: \|		description: \|
	This type represents modifications to a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1.		This type represents modifications to a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1.
			NOTE: At least one of the attributes defined in this type shall be present in request bodies.
	type: object		type: object
	properties:		properties:
	callbackUri:		callbackUri:
	description: \|		description: \|
	New value of the "callbackUri" attribute. The value "null" is not permitted.		New value of the "callbackUri" attribute. The value "null" is not permitted.
	At least one of the attributes defined in this type shall be present in request bodies.		See note.
	$ref: ../../definitions/SOL005_def.yaml#/definitions/Uri		$ref: ../../definitions/SOL005_def.yaml#/definitions/Uri
	authentication:		authentication:
	description: \|		description: \|
	New value of the "authentication" attribute, or "null" to remove the attribute. If present in a request body,		New value of the "authentication" attribute, or "null" to remove the attribute. If present in a request body,
	these modifications shall be applied according to the rules of JSON Merge Patch (see IETF RFC 7396).		these modifications shall be applied according to the rules of JSON Merge Patch (see IETF RFC 7396).

	This attribute shall not be present in response bodies.		This attribute shall not be present in response bodies.
	At least one of the attributes defined in this type shall be present in request bodies.		See note.
	$ref: ../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication		$ref: ../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication
			No newline at end of file

src/SOL005/NFVICapacityInformationNotification/definitions/SOL005NFVICapacityInformationNotification_def.yaml

+2 −1

Original line number	Original line	Diff line number	Diff line
	@@ -7,6 +7,7 @@ components:
	description: \|		description: \|
	This notification informs the receiver that the available NFVI capacity has crossed below a threshold value or		This notification informs the receiver that the available NFVI capacity has crossed below a threshold value or
	has re-covered from a capacity shortage. It shall comply with the provisions defined in Table 10.5.2.10-1.		has re-covered from a capacity shortage. It shall comply with the provisions defined in Table 10.5.2.10-1.
			NOTE: Refer to the definition of the "CapacityThreshold" in clause 10.5.2.7
	required:		required:
	- id		- id
	- notificationType		- notificationType
	@@ -37,7 +38,7 @@ components:
	objectInstanceId:		objectInstanceId:
	description: \|		description: \|
	Identifies the VIM’s NFVI capacity information instance (measured object instance) in which the available		Identifies the VIM’s NFVI capacity information instance (measured object instance) in which the available
	NFVI capacity has crossed a threshold value.		NFVI capacity has crossed a threshold value. See note.
	$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier		$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier
	subObjectInstanceId:		subObjectInstanceId:
	description: \|		description: \|

src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml

+33 −1

Original line number	Original line	Diff line number	Diff line
	definitions:		definitions:
	VnfPkgInfo:		VnfPkgInfo:
			description: >
			This type represents the information of a VNF package. It shall comply with the provisions defined in table 9.5.2.5-1.

			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".
			NOTE 2: If the value of the onboardingState attribute is not equal to "ONBOARDED", the value of the
			usageState attribute shall be equal to "NOT_IN_USE".
			NOTE 3: State changes of a VNF package are illustrated in clause B.2.
			NOTE 4: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA
			specifications.
	type: object		type: object
	required:		required:
	- id		- id
	@@ -103,15 +113,19 @@ definitions:
	$ref: "#/definitions/VnfPackageArtifactInfo"		$ref: "#/definitions/VnfPackageArtifactInfo"
	onboardingState:		onboardingState:
	description: >		description: >
	On-boarding state of the VNF package.		On-boarding state of the VNF package. See note 3.
	$ref: "#/definitions/PackageOnboardingStateType"		$ref: "#/definitions/PackageOnboardingStateType"
	operationalState:		operationalState:
	description: >		description: >
	Operational state of the VNF package.		Operational state of the VNF package.

			See note 1 and note 3.
	$ref: "#/definitions/PackageOperationalStateType"		$ref: "#/definitions/PackageOperationalStateType"
	usageState:		usageState:
	description: >		description: >
	Usage state of the VNF package.		Usage state of the VNF package.

			See note 2 and note 3.
	$ref: "#/definitions/PackageUsageStateType"		$ref: "#/definitions/PackageUsageStateType"
	vnfmInfo:		vnfmInfo:
	description: >		description: >
	@@ -258,6 +272,8 @@ definitions:
	VnfPackageSoftwareImageInfo:		VnfPackageSoftwareImageInfo:
	description: >		description: >
	This type represents an artifact contained in or external to a VNF package which represents a software image.		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®: "Disk and container formats for images".
			NOTE 2: The list of permitted values was adapted from "Disk formats" in OpenStack®: "Disk and container formats for images".
	required:		required:
	- id		- id
	- name		- name
	@@ -311,6 +327,8 @@ definitions:
	- DOCKER: docker container format		- DOCKER: docker container format
	- OVA: OVF package in a tar file		- OVA: OVF package in a tar file
	- OVF: OVF container format		- OVF: OVF container format

			See note 1.
	type: string		type: string
	enum:		enum:
	- AKI		- AKI
	@@ -337,6 +355,8 @@ definitions:
	- VHD: a common disk image format		- VHD: a common disk image format
	- VHDX: enhanced version of VHD format		- VHDX: enhanced version of VHD format
	- VMDK: a common disk image format		- VMDK: a common disk image format

			See note 2.
	type: string		type: string
	enum:		enum:
	- AKI		- AKI
	@@ -623,6 +643,13 @@ definitions:
	in order for the filter to match (logical "and" between different filter attributes).		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		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).		(logical "or" between the values of one filter attribute).

			NOTE 1: The permitted values of the "notificationTypes" attribute are spelled exactly as the names
			of the notification types to facilitate automated code generation systems.
			NOTE 2: The attributes "vnfProductsFromProviders", "vnfdId", and "vnfPkgId" are alternatives to
			reference particular VNF packages in a filter. They should not be used both in the same filter instance,
			but one alternative should be chosen.

	type: object		type: object
	oneOf:		oneOf:
	- required:		- required:
	@@ -638,6 +665,8 @@ definitions:
	Permitted values:		Permitted values:
	- VnfPackageOnboardingNotification		- VnfPackageOnboardingNotification
	- VnfPackageChangeNotification		- VnfPackageChangeNotification

			See note 1.
	type: string		type: string
	enum:		enum:
	- VnfPackageOnboardingNotification		- VnfPackageOnboardingNotification
	@@ -645,6 +674,7 @@ definitions:
	vnfProductsFromProviders:		vnfProductsFromProviders:
	description: >		description: >
	If present, match VNF packages that contain VNF products from certain providers.		If present, match VNF packages that contain VNF products from certain providers.
			See note 2.
	type: array		type: array
	items:		items:
	type: object		type: object
	@@ -699,6 +729,7 @@ definitions:
	description: >		description: >
	Match VNF packages with a VNFD identifier		Match VNF packages with a VNFD identifier
	listed in the attribute.		listed in the attribute.
			See note 2.
	type: array		type: array
	items:		items:
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
	@@ -710,6 +741,7 @@ definitions:
	attribute contains the value		attribute contains the value
	"VnfPackageChangeNotification", and shall be		"VnfPackageChangeNotification", and shall be
	absent otherwise.		absent otherwise.
			See note 2.
	type: array		type: array
	items:		items:
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

src/SOL005/VNFSnapshotPackageManagement/definitions/SOL005VNFSnapshotPackageManagement_def.yaml

+9 −20

Original line number	Original line	Diff line number	Diff line
	@@ -23,6 +23,10 @@ definitions:
	description: >		description: >
	This type represents the information of a VNF snapshot package. It shall comply with the provisions		This type represents the information of a VNF snapshot package. It shall comply with the provisions
	defined in table 11.5.2.3-1.		defined in table 11.5.2.3-1.

			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.
	type: object		type: object
	required:		required:
	- id		- id
	@@ -58,18 +62,12 @@ definitions:
	Checksum of the stored VNF snapshot package.		Checksum of the stored VNF snapshot package.

	Hash algorithms applicable to VNF snapshot package are defined in ETSI GS NFV-SOL 010.		Hash algorithms applicable to VNF snapshot package are defined in ETSI GS NFV-SOL 010.
			See 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.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
	createdAt:		createdAt:
	description: >		description: >
	Timestamp indicating when the VNF snapshot package creation has been completed.		Timestamp indicating when the VNF snapshot package creation has been completed.
			See 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.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"		$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
	vnfSnapshotId:		vnfSnapshotId:
	description: >		description: >
	@@ -85,10 +83,7 @@ definitions:
	Identifier of information held by the VNFM about specific VNFC snapshot(s) part of the VNF		Identifier of information held by the VNFM about specific VNFC snapshot(s) part of the VNF
	snapshot and contained in the VNF snapshot package. This identifier is allocated by the VNFM		snapshot and contained in the VNF snapshot package. This identifier is allocated by the VNFM
	during the VNF snapshot creation.		during the VNF snapshot creation.
			See 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.
	type: array		type: array
	items:		items:
	$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierLocal"		$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierLocal"
	@@ -100,10 +95,7 @@ definitions:
	vnfdInfo:		vnfdInfo:
	description: >		description: >
	VNFD of the snapshotted VNF instance that is contained in the stored VNF snapshot package.		VNFD of the snapshotted VNF instance that is contained in the stored VNF snapshot package.
			See 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.
	$ref: '#/definitions/VnfdInfo'		$ref: '#/definitions/VnfdInfo'
	vnfsr:		vnfsr:
	description: >		description: >
	@@ -114,10 +106,7 @@ definitions:
	description: >		description: >
	Information about VNF snapshot artifacts that are VNFC snapshot images. Every local and		Information about VNF snapshot artifacts that are VNFC snapshot images. Every local and
	external snapshot image shall be included. No other artifacts shall be included.		external snapshot image shall be included. No other artifacts shall be included.
			See 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.
	type: array		type: array
	items:		items:
	$ref: '#/definitions/VnfcSnapshotImageInfo'		$ref: '#/definitions/VnfcSnapshotImageInfo'

Admin message