Skip to content
GitLab
Commit 41aeb69c authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

separate notification definitions files for SOL002 and SOL003

parent 6313e982
Pipeline #13216 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL002/VNFIndicator/definitions/SOL002VNFIndicator_def.yaml
View file @ 41aeb69c
......@@ -149,154 +149,3 @@ definitions:
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/SubscriptionAuthentication"
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.
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.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- vnfIndicatorId
- value
- 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: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"VnfIndicatorValueChangeNotification" for this notification type.
type: string
enum:
- VnfIndicatorValueChangeNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
vnfIndicatorId:
description: >
Identifier of the VNF indicator whose value has changed.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd"
name:
description: >
Human readable name of the VNF indicator. Shall be present if
defined in the VNFD.
type: string
value:
description: >
Provides the value of the VNF indicator. The value format is defined in the VNFD. See note.
type: object
vnfInstanceId:
description: >
Identifier of the VNF instance which provides the indicator value.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
_links:
description: >
Links for this resource.
type: object
required:
- vnfInstance
- subscription
properties:
vnfInstance:
description: >
Link to the related "Individual VNF instance" resource. Shall be present
if the VNF instance information is accessible as a resource.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
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.
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
a VNF has been instantiated.
NOTE: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
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: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"SupportedIndicatorsChangeNotification" for this notification type.
type: string
enum:
- VnfIndicatorValueChangeNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
Identifier of the VNF instance which provides the indicator value.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
supportedIndicators:
description: >
Set of VNF indicators supported by the VNF instance.
type: array
items:
type: object
required:
- vnfIndicatorId
properties:
vnfIndicatorId:
description: >
Identifier of the VNF indicator whose value has changed.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd"
name:
description: >
Human readable name of the VNF indicator. Shall be present if defined in the VNFD. See note.
type: string
_links:
description: >
Links for this resource.
type: object
required:
- subscription
properties:
vnfInstance:
description: >
Link to the related "Individual VNF instance" resource. Shall be present
if the VNF instance information is accessible as a resource.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
\ No newline at end of file
src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml
View file @ 41aeb69c
......@@ -1684,7 +1684,7 @@ components:
content:
application/json:
schema:
$ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification"
$ref: "../VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml#/definitions/VnfIdentifierDeletionNotification"
IndividualVnfInstance.Delete.409:
description: |
......
src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml
View file @ 41aeb69c
......@@ -2600,95 +2600,6 @@ definitions:
- FORCEFUL
########################################################################################################################
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: "../../General_Definitions/SOL002_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: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
The created VNF instance identifier.
$ref: "../../General_Definitions/SOL002_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: "../../General_Definitions/SOL002_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: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
The deleted VNF instance identifier.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
_links:
description: >
Links to resources related to this notification.
$ref: "#/definitions/LccnLinks"
VnfcInfoModifications:
description: >
......
src/SOL002/VNFPerformanceManagement/definitions/SOL002VNFPerformanceManagement_def.yaml
View file @ 41aeb69c
......@@ -106,94 +106,6 @@ definitions:
requires authorization of notifications.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/SubscriptionAuthentication"
PerformanceInformationAvailableNotification:
description: >
This notification informs the receiver that performance information is
available.
The notification shall be triggered by the VNFM when new performance
information collected by a PM job is available.
The periodicity of triggering this notification is influenced by the
"reportingPeriod" attribute in the "PmJobCriteria" data structure.
type: object
required:
- id
- notificationType
- timeStamp
- pmJobId
- objectType
- objectInstanceId
- _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: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"PerformanceInformationAvailableNotification" for this notification
type.
type: string
enum:
- PerformanceInformationAvailableNotification
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
pmJobId:
description: >
Identifier of the PM job for which performance information is available.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
objectType:
description: >
Type of the measured object.
The applicable measured object type for a measurement
is defined in clause 7.2 of ETSI GS NFV-IFA 027.
type: string
objectInstanceId:
description: >
Identifier of the measured object instance. as per clause 6.2 of ETSI GS NFV-IFA 027.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
subObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured
object instance for which the measurements have been taken.
Shall be present if the related PM job has been set up to
measure only a subset of all sub-object instances of the
measured object instance and a sub-object is defined in clause
6.2 of ETSI GS NFV-IFA 027 for the related measured object type.
Shall be absent otherwise.
type: array
items:
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf"
_links:
description: >
Links to resources related to this notification.
type: object
required:
- pmJob
- performanceReport
properties:
objectInstance:
description: >
Link to the resource representing the measured object instance to which the
notification applies. Shall be present if the measured object instance
information is accessible as a resource.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
pmJob:
description: >
Link to the resource that represents the PM job for which
performance information is available.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
performanceReport:
description: >
Link from which the available performance information of data
type "PerformanceReport" can be obtained. This link should point
to an "Individual performance report" resource.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
PerformanceReport:
description: >
This type defines the format of a performance report provided by the VNFM to the NFVO as a result of collecting
......@@ -608,107 +520,3 @@ definitions:
minimum: 0
maximum: 1024
format: float
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.
NOTE: The timing of sending this notification is determined by the capability of the
producing entity to evaluate the threshold crossing condition.
The notification shall be triggered by the VNFM when a threshold has been crossed.
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.
type: object
required:
- id
- notificationType
- timeStamp
- thresholdId
- crossingDirection
- objectType
- objectInstanceId
- performanceMetric
- performanceValue
- _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: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"ThresholdCrossedNotification" for this notification type.
type: string
enum:
- ThresholdCrossedNotification
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
thresholdId:
description: >
Identifier of the threshold which has been crossed.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
crossingDirection:
description: >
An indication of whether the threshold was crossed in upward or
downward direction.
$ref: "#/definitions/CrossingDirectionType"
objectType:
description: >
Type of the measured object.
The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027.
type: string
objectInstanceId:
description: >
Identifier that identifies a VNF instance.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
subObjectInstanceId:
description: >
Identifier of the sub-object of the measured object to which the measurement applies.
Shall be present if this is required in clause 6.2 of ETSI GS NFV-IFA 027 for the related
measured object type.
See note.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf"
performanceMetric:
description: >
Performance metric associated with the threshold.
This attribute shall contain the related "Measurement Name"
value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
type: string
performanceValue:
description: >
Value of the metric that resulted in threshold crossing.
The type of this attribute shall correspond to the related
"Measurement Unit" as defined in clause 7.2 of ETSI GS NFV-IFA 027.
type: object
context:
description: >
Measurement context information related to the measured value.
The set of applicable keys is defined per measurement in the
related "Measurement Context" in clause 7.2 of ETSI GS NFV-IFA 027.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs"
_links:
description: >
Links to resources related to this notification.
type: object
required:
- threshold
properties:
objectInstance:
description: >
Link to the resource representing the measured object instance to which the
notified change applies. Shall be present if the measured object instance
information is accessible as a resource.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
threshold:
description: >
Link to the resource that represents the threshold that was
crossed.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
\ No newline at end of file
src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml
View file @ 41aeb69c
......@@ -144,61 +144,6 @@ definitions:
notified alarm is correlated. Shall be present if the VNF
instance information is accessible as a resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
AlarmNotification:
description: >
This type represents an alarm notification about VNF faults.
This notification shall be triggered by the VNFM when:
* An alarm has been created.
* An alarm has been updated, e.g. if the severity of the alarm has
changed.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- alarm
- _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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"AlarmNotification" for this notification type.
type: string
enum:
- AlarmNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
alarm:
description: >
Information about an alarm including AlarmId, affected VNF
identifier, and FaultDetails.
$ref: "#/definitions/Alarm"
_links:
description: >
Links to resources related to this notification.
type: object
required:
- subscription
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/NotificationLink"
FmSubscriptionRequest:
description: >
......
src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml
View file @ 41aeb69c
......@@ -202,7 +202,7 @@ components:
content:
application/json:
schema:
$ref: "../VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
$ref: "definitions/SOL003VNFFaultManagementNotification_def.yaml#/definitions/AlarmNotification"
required: true
AlarmClearedNotification:
......
src/SOL003/VNFFaultManagementNotification/definitions/SOL003VNFFaultManagementNotification_def.yaml
View file @ 41aeb69c
......@@ -23,7 +23,7 @@ definitions:
Identifier of this notification. If a notification is sent multiple
times due to multiple subscriptions, the "id" attribute of all these
notifications shall have the same value.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
......@@ -34,16 +34,16 @@ definitions:
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
alarm:
description: >
Information about an alarm including AlarmId, affected VNF
identifier, and FaultDetails.
$ref: "../../VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm"
$ref: "../../VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
_links:
description: >
Links to resources related to this notification.
......@@ -54,7 +54,7 @@ definitions:
subscription:
description: >
Link to the related subscription.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/NotificationLink"
AlarmClearedNotification:
description: >
......
src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml
View file @ 41aeb69c
......@@ -1996,224 +1996,6 @@ definitions:
It shall be present when an applicable GrantInfo for the granted resource exists. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"
VnfLcmOperationO