Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
NFV - Network Functions Virtualisation
SOL002-SOL003
Commits
b6e81455
Commit
b6e81455
authored
Oct 31, 2022
by
Muhammad Hamza
Browse files
separate common definitions files for SOL002 and SOL003
parent
3b85aa16
Pipeline
#13211
failed with stage
in 0 seconds
Changes
18
Pipelines
1
Expand all
Hide whitespace changes
Inline
Side-by-side
src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml
View file @
b6e81455
...
...
@@ -406,7 +406,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFFaultManagement_def.yaml#/definitions/AlarmModifications
$ref
:
definitions/SOL002VNFFaultManagement_def.yaml#/definitions/AlarmModifications
required
:
true
IndividualAlarmEscalateRequest
:
...
...
@@ -422,7 +422,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest
$ref
:
definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest
required
:
true
responses
:
...
...
@@ -558,7 +558,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFFaultManagement_def.yaml#/definitions/AlarmModifications
$ref
:
definitions/SOL002VNFFaultManagement_def.yaml#/definitions/AlarmModifications
IndividualAlarm.Patch.409
:
description
:
|
...
...
@@ -657,7 +657,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFFaultManagement_def.yaml#/definitions/FmSubscription
$ref
:
definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscription
Subscriptions.Post.201
:
description
:
|
...
...
@@ -697,7 +697,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFFaultManagement_def.yaml#/definitions/FmSubscription
$ref
:
definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscription
Subscriptions.Post.422
:
description
:
|
...
...
@@ -767,7 +767,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFFaultManagement_def.yaml#/definitions/FmSubscription
$ref
:
definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscription
IndividualSubscription.Delete.204
:
description
:
|
...
...
src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml
View file @
b6e81455
...
...
@@ -61,7 +61,7 @@ definitions:
description
:
>
The virtualised resources that are causing the VNF fault. Shall be present if the alarm affects
virtualised resources. See note 1.
$ref
:
"
../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml
#/definitions/FaultyResourceInfo"
$ref
:
"
#/definitions/FaultyResourceInfo"
alarmRaisedTime
:
description
:
>
Time stamp indicating when the alarm is raised by the managed
...
...
@@ -96,7 +96,7 @@ definitions:
perceivedSeverity
:
description
:
>
Perceived severity of the managed object failure.
$ref
:
"
../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml
#/definitions/PerceivedSeverityType"
$ref
:
"
#/definitions/PerceivedSeverityType"
eventTime
:
description
:
>
Time stamp indicating when the fault was observed. See note 2.
...
...
@@ -104,7 +104,7 @@ definitions:
eventType
:
description
:
>
Type of event.
$ref
:
"
../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml
#/definitions/EventType"
$ref
:
"
#/definitions/EventType"
type
:
string
faultType
:
description
:
>
...
...
@@ -169,4 +169,240 @@ definitions:
proposedPerceivedSeverity
:
description
:
>
Indicates the proposed escalated perceived severity for an alarm.
$ref
:
"
../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
\ No newline at end of file
$ref
:
"
#/definitions/PerceivedSeverityType"
FmSubscriptionRequest
:
description
:
>
This type represents a subscription request related to notifications
about VNF faults.
type
:
object
required
:
-
callbackUri
properties
:
filter
:
description
:
>
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular
notification is sent to the subscriber if the filter matches, or if
there is no filter.
$ref
:
"
#/definitions/FmNotificationsFilter"
callbackUri
:
description
:
>
The URI of the endpoint to send the notification to.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/Uri"
authentication
:
description
:
>
Authentication parameters to configure the use of Authorization when sending notifications
corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires authorization of notifications.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/SubscriptionAuthentication"
FmSubscription
:
description
:
>
This type represents a subscription related to notifications about VNF
faults.
type
:
object
required
:
-
id
-
callbackUri
-
_links
properties
:
id
:
description
:
>
Identifier of this "Individual subscription" resource.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
filter
:
description
:
>
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular
notification is sent to the subscriber if the filter matches, or if
there is no filter.
$ref
:
"
#/definitions/FmNotificationsFilter"
callbackUri
:
description
:
>
The URI of the endpoint to send the notification to.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/Uri"
_links
:
description
:
>
Links for this resource.
type
:
object
required
:
-
self
properties
:
self
:
description
:
>
URI of this resource.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/Link"
AlarmModifications
:
description
:
>
This type represents attribute modifications for an "Individual alarm"
resource, i.e. modifications to a resource representation based on the
"Alarm" data type. The attributes of "Alarm" that can be modified
are included in the "AlarmModifications" data type.
type
:
object
required
:
-
ackState
properties
:
ackState
:
description
:
>
New value of the "ackState" attribute in "Alarm".
Permitted values:
* ACKNOWLEDGED
* UNACKNOWLEDGED
type
:
string
enum
:
-
ACKNOWLEDGED
-
UNACKNOWLEDGED
EventType
:
description
:
>
The enumeration EventType represents those types of events that trigger
an alarm.
* COMMUNICATIONS_ALARM: An alarm of this type is associated with the
procedure and/or process required conveying information from one point
to another (ITU-T Recommendation X.733).
* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a
software or processing fault (ITU-T Recommendation X.733).
* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a
condition related to an enclosure in which the equipment resides
(ITU-T Recommendation X.733).
* QOS_ALARM: An alarm of this type is associated with degradation in the
quality of a service (ITU-T Recommendation X.733).
* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment
fault (ITU-T Recommendation X.733).
type
:
string
enum
:
-
COMMUNICATIONS_ALARM
-
PROCESSING_ERROR_ALARM
-
ENVIRONMENTAL_ALARM
-
QOS_ALARM
-
EQUIPMENT_ALARM
FaultyResourceInfo
:
description
:
>
This type represents the faulty virtual resources that have a negative
impact on a VNF.
type
:
object
required
:
-
faultyResource
-
faultyResourceType
properties
:
faultyResource
:
description
:
>
Information that identifies the faulty resource instance and its
managing entity.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/ResourceHandle"
faultyResourceType
:
description
:
>
Type of the faulty resource.
$ref
:
"
#/definitions/FaultyResourceType"
FaultyResourceType
:
description
:
>
The enumeration FaultyResourceType represents those types of faulty
resource.
type
:
string
enum
:
-
COMPUTE
-
STORAGE
-
NETWORK
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
matches (logical "or" between the values of one filter attribute).
NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names
of the notification types to facilitate automated code generation systems.
type
:
object
properties
:
vnfInstanceSubscriptionFilter
:
description
:
>
Filter criteria to select VNF instances about which to notify.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/VnfInstanceSubscriptionFilter"
notificationTypes
:
description
:
>
Match particular notification types.
Permitted values:
- AlarmNotification
- AlarmClearedNotification
- AlarmListRebuiltNotification
See note.
type
:
array
items
:
type
:
string
enum
:
-
AlarmNotification
-
AlarmClearedNotification
-
AlarmListRebuiltNotification
faultyResourceTypes
:
description
:
>
Match VNF alarms with a faulty resource type listed in this
attribute.
type
:
array
items
:
$ref
:
"
#/definitions/FaultyResourceType"
perceivedSeverities
:
description
:
>
Match VNF alarms with a perceived severity listed in this attribute.
type
:
array
items
:
$ref
:
"
#/definitions/PerceivedSeverityType"
eventTypes
:
description
:
>
Match VNF alarms with an event type listed in this attribute.
type
:
array
items
:
$ref
:
"
#/definitions/EventType"
probableCauses
:
description
:
>
Match VNF alarms with a probable cause listed in this attribute.
type
:
array
items
:
type
:
string
PerceivedSeverityType
:
description
:
>
Indicates the relative level of urgency for operator attention.
* CRITICAL: The Critical severity level indicates that a service
affecting condition has occurred and an immediate corrective action
is required. Such a severity can be reported, for example, when a
managed object becomes totally out of service and its capability needs
to be restored (ITU-T Recommendation X.733).
* MAJOR: The Major severity level indicates that a service affecting
condition has developed and an urgent corrective action is required.
Such a severity can be reported, for example, when there is a severe
degradation in the capability of the managed object and its full
capability needs to be restored (ITU-T Recommendation X.733).
* MINOR: The Minor severity level indicates the existence of a
non-service affecting fault condition and that corrective action
should be taken in order to prevent a more serious (for example,
service affecting) fault. Such a severity can be reported, for
example, when the detected alarm condition is not currently degrading
the capacity of the managed object (ITU-T Recommendation X.733).
* WARNING: The Warning severity level indicates the detection of a
potential or impending service affecting fault, before any significant
effects have been felt. Action should be taken to further diagnose (if
necessary) and correct the problem in order to prevent it from
becoming a more serious service affecting fault (ITU-T Recommendation
X.733).
* INDETERMINATE: The Indeterminate severity level indicates that the
severity level cannot be determined (ITU-T Recommendation X.733).
* CLEARED: The Cleared severity level indicates the clearing of one or
more previously reported alarms. This alarm clears all alarms for this
managed object that have the same Alarm type, Probable cause and
Specific problems (if given) (ITU-T Recommendation X.733).
type
:
string
enum
:
-
CRITICAL
-
MAJOR
-
MINOR
-
WARNING
-
INDETERMINATE
-
CLEARED
src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml
View file @
b6e81455
...
...
@@ -200,7 +200,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification
$ref
:
definitions/SOL002VNFFaultManagement
Notification
_def.yaml#/definitions/AlarmClearedNotification
required
:
true
AlarmListRebuiltNotification
:
...
...
@@ -209,7 +209,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification
$ref
:
definitions/SOL002VNFFaultManagement
Notification
_def.yaml#/definitions/AlarmListRebuiltNotification
required
:
true
responses
:
...
...
src/SOL002/VNFFaultManagementNotification/definitions/SOL002VNFFaultManagementNotification_def.yaml
View file @
b6e81455
...
...
@@ -54,4 +54,119 @@ definitions:
subscription
:
description
:
>
Link to the related subscription.
$ref
:
"
../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
\ No newline at end of file
$ref
:
"
../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
AlarmClearedNotification
:
description
:
>
This type represents an alarm cleared notification about VNF faults.
The notification shall be triggered by the VNFM when an alarm has been
cleared.
type
:
object
required
:
-
id
-
notificationType
-
subscriptionId
-
timeStamp
-
alarmId
-
alarmClearedTime
-
_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
"AlarmClearedNotification" for this notification type.
type
:
string
enum
:
-
AlarmClearedNotification
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"
alarmId
:
description
:
>
Alarm identifier.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"
alarmClearedTime
:
description
:
>
The time stamp indicating when the alarm was cleared.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/DateTime"
_links
:
description
:
>
Links to resources related to this notification.
type
:
object
required
:
-
subscription
-
alarm
properties
:
subscription
:
description
:
>
Link to the related subscription.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
alarm
:
description
:
>
Link to the resource that represents the related alarm.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
AlarmListRebuiltNotification
:
description
:
>
This type represents a notification that the alarm list has been
rebuilt, e.g. if the VNFM detects its storage holding the alarm
list is corrupted.
The notification shall be triggered by the VNFM when the alarm list has
been rebuilt, e.g. because the VNFM has detected that its storage
holding the alarm list was corrupted.
type
:
object
required
:
-
id
-
notificationType
-
subscriptionId
-
timeStamp
-
_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
"AlarmListRebuiltNotification" for this notification type.
type
:
string
enum
:
-
AlarmListRebuiltNotification
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"
_links
:
description
:
>
Links to resources related to this notification.
type
:
object
required
:
-
subscription
-
alarms
properties
:
subscription
:
description
:
>
Link to the related subscription.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
alarms
:
description
:
>
Link to the alarm list, i.e. the "Alarms" resource.
$ref
:
"
../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink"
\ No newline at end of file
src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml
View file @
b6e81455
...
...
@@ -200,7 +200,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification
$ref
:
"
definitions/SOL002VNFLifecycleManagement
Notification
_def.yaml#/definitions/VnfIdentifierCreationNotification
"
required
:
true
VnfIdentifierDeletionNotification
:
...
...
@@ -209,7 +209,7 @@ components:
content
:
application/json
:
schema
:
$ref
:
../../
definitions/SOL002
SOL003
VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification
$ref
:
"
definitions/SOL002VNFLifecycleManagement
Notification
_def.yaml#/definitions/VnfIdentifierDeletionNotification
"
required
:
true
responses
:
...
...
src/SOL002/VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml
View file @
b6e81455
...
...
@@ -98,7 +98,7 @@ definitions:
operationState
:
description
:
>
The state of the VNF LCM operation occurrence.
$ref
:
"
../../
..
/definitions/SOL002
SOL003
VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType"
$ref
:
"
../../
VNFLifecycleManagement
/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType"
vnfInstanceId
:
description
:
>
The identifier of the VNF instance affected.
...
...
@@ -120,7 +120,7 @@ definitions:
This attribute signals the verbosity of the notification. If it is not present, it shall default to the value "FULL".
If the value is "SHORT", full change details can be obtained by performing a GET request on the "Individual LCM
operation occurrence" resource that is signalled by the "vnfLcmOpOcc" child attribute of the "_links" attribute.
$ref
:
"
../../
..
/definitions/SOL002
SOL003
VNFLifecycleManagement_def.yaml#/definitions/LcmOpOccNotificationVerbosityType"
$ref
:
"
../../
VNFLifecycleManagement
/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/LcmOpOccNotificationVerbosityType"
vnfLcmOpOccId
:
description
:
>
The identifier of the VNF lifecycle management operation occurrence
...
...
@@ -174,7 +174,7 @@ definitions:
VIP CP instances that have been added, deleted or modified shall be provided.
type
:
array
items
:
$ref
:
"
../../
..
/definitions/SOL002
SOL003
VNFLifecycleManagement_def.yaml#/definitions/AffectedVipCp"
$ref
:
"
../../
VNFLifecycleManagement
/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/AffectedVipCp"
changedExtConnectivity
:
description
:
>
Information about changed external connectivity, if this
...
...
@@ -185,14 +185,14 @@ definitions:
Shall be absent otherwise.
type
:
array
items
:
$ref
:
"
../../
..
/definitions/SOL002
SOL003
VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
$ref
:
"
../../
VNFLifecycleManagement
/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
modificationsTriggeredByVnfPkgChange
:
description
:
>
Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package.
Shall be present if the "notificationStatus" is set to "RESULT", the "operation" attribute is equal to
"CHANGE_VNFPKG", the "verbosity" attribute is set to "FULL" and the operation has performed any changes to
"VnfInstance" attributes. Shall be absent otherwise. See note 3
$ref
:
"
../../
..
/definitions/SOL002
SOL003
VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange"
$ref
:
"
../../
VNFLifecycleManagement
/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange"
error
:
description
:
>
Details of the latest error, if one has occurred during executing
...
...
@@ -203,4 +203,94 @@ definitions:
_links
:
description
:
>
Links to resources related to this notification.
$ref
:
"
../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnLinks"
\ No newline at end of file
$ref
:
"
../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/LccnLinks"
VnfIdentifierCreationNotification
:
description
:
>
This type represents a VNF identifier creation notification, which
informs the receiver of the creation of a new "Individual VNF instance" resource and
the associated VNF instance identifier.
This notification shall be triggered by the VNFM when it has created an
"Individual VNF instance" resource and the associated VNF instance identifier.
type
:
object
required
:
-
id
-
notificationType
-
subscriptionId
-
timeStamp
-
vnfInstanceId
-
_links
properties
:
id
:
description
:
>
Identifier of the VNF instance.
$ref
:
"
../../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
:
"
../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/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
: