"description":"This type represents the faulty component that has a negative impact on an NS. It shall comply with the provisions defined in Table 8.5.3.4-1.\n",
"type":"object",
"properties":{
"faultyNestedNsInstanceId":{
"description":"Identifier of the faulty nested NS instance.\n",
"$ref":"SOL005_def.yaml#/definitions/Identifier"
},
"faultyResourceType":{
"description":"Identifier of the faulty NS virtual link instance.\n",
"$ref":"SOL005_def.yaml#/definitions/Identifier"
},
"faultyNsVirtualLinkInstanceId":{
"description":"Identifier of the faulty VNF instance.\n",
"description":"This type represents a subscription filter related to notifications about NS faults. 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 the values in the array matches (logical \"or\" between the values of one filter attribute)..\n",
"type":"object",
"properties":{
"nsInstanceSubscriptionFilter":{
"description":"Filter criteria to select NS instances about which to notify. \n",
"description":"Identifier of this subscription resource.\n",
"$ref":"SOL005_def.yaml#/definitions/Identifier"
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"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.\n",
"$ref":"#/definitions/FmNotificationsFilter"
"description":"This type represents a subscription filter related to notifications about NS faults. 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 the values in the array matches (logical \"or\" between the values of one filter attribute)..\n",
"type":"object",
"properties":{
"nsInstanceSubscriptionFilter":{
"description":"This type represents subscription filter criteria to match NS instances.\nNOTE 1: The attributes \"nsdIds\", \"vnfdIds\" and \"pnfdIds\" are alternatives to reference to NS instances that are created based on certain NSDs, or contain VNF instances that are based on certain VNFDs, or contain PNFs that are based on certain PNFDs in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\nNOTE 2: The attributes \"nsInstanceIds\" and \"nsInstanceNames\" are alternatives to reference to particular NS Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type":"object",
"properties":{
"nsdIds":{
"description":"If present, match NS instances that were created based on a NSD identified by one of the nsdId values listed in this attribute.\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
},
"vnfdIds":{
"description":"If present, match NS instances that contain VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute.\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
},
"pnfdIds":{
"description":"If present, match NS instances that contain PNFs that are represented by a PNFD identified by one of the pnfdId values listed in this attribute.\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
},
"nsInstanceIds":{
"description":"If present, match NS instances with an instance identifier listed in this attribute.\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
},
"nsInstanceNames":{
"description":"If present, match NS instances with a NS Instance Name listed in this attribute.\n",
"type":"array",
"items":{
"description":"A string as defined in IETF RFC 8259.\n",
"description":"Match VNF alarms with a perceived severity listed in this attribute.\n",
"type":"array",
"items":{
"description":"Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service\n affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting\n condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a\n non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a\n potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the\n severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or\n more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
"type":"string",
"enum":[
"CRITICAL",
"MAJOR",
"MINOR",
"WARNING",
"INDETERMINATE",
"CLEARED"
]
}
},
"eventTypes":{
"description":"Match VNF alarms related to NSs with an event type listed in this attribute.\n",
"type":"array",
"items":{
"description":"The enumeration EventType represents those types of events that trigger an alarm. - COMMUNICATIONS_ALARM: An alarm of this type is associated with the\n procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n- PROCESSING_ERROR_ALARM: An alarm of this type is associated with a\n software or processing fault (ITU-T Recommendation X.733).\n- ENVIRONMENTAL_ALARM: An alarm of this type is associated with a\n condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n- QOS_ALARM: An alarm of this type is associated with degradation in the\n quality of a service (ITU-T Recommendation X.733).\n- EQUIPMENT_ALARM: An alarm of this type is associated with an equipment\n fault (ITU-T Recommendation X.733).\n",
"type":"string",
"enum":[
"COMMUNICATIONS_ALARM",
"PROCESSING_ERROR_ALARM",
"ENVIRONMENTAL_ALARM",
"QOS_ALARM",
"EQUIPMENT_ALARM"
]
}
},
"probableCauses":{
"description":"Match VNF alarms with a probable cause listed in this attribute.\n",
"type":"array",
"items":{
"type":"string"
}
}
}
},
"callbackUri":{
"description":"The URI of the endpoint to send the notification to.\n",
...
...
@@ -28,8 +139,18 @@
],
"properties":{
"self":{
"description":"URI of this resource.\n",
"$ref":"SOL005_def.yaml#/definitions/Link"
"description":"This type represents a link to a resource.\n",
"type":"object",
"required":[
"href"
],
"properties":{
"href":{
"description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"description":"This type represents a subscription request related to notifications about VNF faults.\n",
"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.\n",
"$ref":"#/definitions/FmNotificationsFilter"
},
"callbackUri":{
"description":"The URI of the endpoint to send the notification to.\n",
"type":"string",
"format":"url"
},
"authentication":{
"description":"Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription. This attribute shall only be present if the subscriber requires authorization of notifications.\n",
"description":"This type represents a subscription related to notifications about VNF faults.\n",
"type":"object",
"required":[
"id",
"callbackUri",
"_links"
],
"properties":{
"id":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"filter":{
"description":"This type represents a subscription filter related to notifications about NS faults. 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 the values in the array matches (logical \"or\" between the values of one filter attribute)..\n",
"type":"object",
"properties":{
"nsInstanceSubscriptionFilter":{
"description":"This type represents subscription filter criteria to match NS instances.\nNOTE 1: The attributes \"nsdIds\", \"vnfdIds\" and \"pnfdIds\" are alternatives to reference to NS instances that are created based on certain NSDs, or contain VNF instances that are based on certain VNFDs, or contain PNFs that are based on certain PNFDs in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\nNOTE 2: The attributes \"nsInstanceIds\" and \"nsInstanceNames\" are alternatives to reference to particular NS Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type":"object",
"properties":{
"nsdIds":{
"description":"If present, match NS instances that were created based on a NSD identified by one of the nsdId values listed in this attribute.\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
},
"vnfdIds":{
"description":"If present, match NS instances that contain VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute.\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
},
"pnfdIds":{
"description":"If present, match NS instances that contain PNFs that are represented by a PNFD identified by one of the pnfdId values listed in this attribute.\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
},
"nsInstanceIds":{
"description":"If present, match NS instances with an instance identifier listed in this attribute.\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
},
"nsInstanceNames":{
"description":"If present, match NS instances with a NS Instance Name listed in this attribute.\n",
"type":"array",
"items":{
"description":"A string as defined in IETF RFC 8259.\n",
"description":"Match VNF alarms with a perceived severity listed in this attribute.\n",
"type":"array",
"items":{
"description":"Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service\n affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting\n condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a\n non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a\n potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the\n severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or\n more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
"type":"string",
"enum":[
"CRITICAL",
"MAJOR",
"MINOR",
"WARNING",
"INDETERMINATE",
"CLEARED"
]
}
},
"eventTypes":{
"description":"Match VNF alarms related to NSs with an event type listed in this attribute.\n",
"type":"array",
"items":{
"description":"The enumeration EventType represents those types of events that trigger an alarm. - COMMUNICATIONS_ALARM: An alarm of this type is associated with the\n procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n- PROCESSING_ERROR_ALARM: An alarm of this type is associated with a\n software or processing fault (ITU-T Recommendation X.733).\n- ENVIRONMENTAL_ALARM: An alarm of this type is associated with a\n condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n- QOS_ALARM: An alarm of this type is associated with degradation in the\n quality of a service (ITU-T Recommendation X.733).\n- EQUIPMENT_ALARM: An alarm of this type is associated with an equipment\n fault (ITU-T Recommendation X.733).\n",
"type":"string",
"enum":[
"COMMUNICATIONS_ALARM",
"PROCESSING_ERROR_ALARM",
"ENVIRONMENTAL_ALARM",
"QOS_ALARM",
"EQUIPMENT_ALARM"
]
}
},
"probableCauses":{
"description":"Match VNF alarms with a probable cause listed in this attribute.\n",
"type":"array",
"items":{
"type":"string"
}
}
}
},
"callbackUri":{
"description":"The URI of the endpoint to send the notification to.\n",
"type":"string",
"format":"url"
},
"_links":{
"description":"Links for this resource.\n",
"type":"object",
"required":[
"self"
],
"properties":{
"self":{
"description":"This type represents a link to a resource.\n",
"type":"object",
"required":[
"href"
],
"properties":{
"href":{
"description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"description":"Identifier of this Alarm information element.\n",
"$ref":"SOL005_def.yaml#/definitions/Identifier"
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"managedObjectId":{
"description":"Identifier of the affected NS instance.\n",
"$ref":"SOL005_def.yaml#/definitions/Identifier"
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"rootCauseFaultyComponent":{
"description":"The NS components that are causing the NS fault.\n",
"$ref":"#/definitions/FaultyComponentInfo"
"description":"This type represents the faulty component that has a negative impact on an NS. It shall comply with the provisions defined in Table 8.5.3.4-1.\n",
"type":"object",
"properties":{
"faultyNestedNsInstanceId":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"faultyResourceType":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"faultyNsVirtualLinkInstanceId":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
}
}
},
"rootCauseFaultyResource":{
"description":"The virtualised resources that are causing the NS fault. It shall be present when the faulty component is \"NS Virtual Link\" or \"VNF\".\n",
"$ref":"#/definitions/FaultyResourceInfo"
"description":"This type represents the faulty virtual resources that have a negative impact on a NS.\n",
"type":"object",
"required":[
"faultyResource",
"faultyResourceType"
],
"properties":{
"faultyResource":{
"description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n",
"type":"object",
"required":[
"resourceId"
],
"properties":{
"vimId":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"resourceProviderId":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"resourceId":{
"description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type":"string"
},
"vimLevelResourceType":{
"description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
"description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"format":"date-time"
},
"alarmChangedTime":{
"description":"The time stamp indicating when the alarm was cleared.\n",
"$ref":"SOL005_def.yaml#/definitions/DateTime"
"description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"format":"date-time"
},
"alarmClearedTime":{
"description":"Links to resources related to this notification.\n",
"$ref":"SOL005_def.yaml#/definitions/DateTime"
"description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"format":"date-time"
},
"ackState":{
"description":"Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED\n",
...
...
@@ -52,16 +106,31 @@
]
},
"perceivedSeverity":{
"description":"Perceived severity of the managed object failure.\n",
"$ref":"#/definitions/PerceivedSeverityType"
"description":"Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service\n affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting\n condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a\n non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a\n potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the\n severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or\n more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n",
"type":"string",
"enum":[
"CRITICAL",
"MAJOR",
"MINOR",
"WARNING",
"INDETERMINATE",
"CLEARED"
]
},
"eventTime":{
"description":"Time stamp indicating when the fault was observed.\n",
"$ref":"SOL005_def.yaml#/definitions/DateTime"
"description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"format":"date-time"
},
"eventType":{
"description":"Type of event.\n",
"$ref":"#/definitions/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\n procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n- PROCESSING_ERROR_ALARM: An alarm of this type is associated with a\n software or processing fault (ITU-T Recommendation X.733).\n- ENVIRONMENTAL_ALARM: An alarm of this type is associated with a\n condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n- QOS_ALARM: An alarm of this type is associated with degradation in the\n quality of a service (ITU-T Recommendation X.733).\n- EQUIPMENT_ALARM: An alarm of this type is associated with an equipment\n fault (ITU-T Recommendation X.733).\n",
