updated Alarm, Alarms, AlarmNotification schema as per NFVSOL(24)000024 (7f3b89b2) · Commits · NFV - Network Functions Virtualisation / api-tests

SOL005/NSFaultManagement-API/schemas/alarm.schema.json

+214 −174

Original line number	Diff line number	Diff line
		{
		"description": "The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in Table 8.5.2.4-1\n",
		"type": "object",
		"required": ["id", "managedObjectId", "alarmRaisedTime", "ackState", "perceivedSeverity", "eventTime", "eventType", "probableCause", "isRootCause", "_links"],
		"required": [
		"id",
		"managedObjectId",
		"alarmRaisedTime",
		"ackState",
		"perceivedSeverity",
		"eventTime",
		"eventType",
		"probableCause",
		"isRootCause",
		"_links"
		],
		"properties": {
		"id": {
		"description": "An identifier with the intention of being globally unique.\n",
		@@ -32,12 +43,17 @@
		"rootCauseFaultyResource": {
		"description": "This type represents the faulty virtual resources that have a negative impact on a NS.\n",
		"type": "object",
		"required": ["faultyResource", "faultyResourceType"],
		"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.\nNOTE 1:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the CISM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. When the container infrastructure service is a Kubernetes® instance the vimLevelResourceType is the type of resource, as would correspond to the ‘kind’ field if the resource is declared in its own Kubernetes® manifest, e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition. NOTE 2:\tWhen the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the following way: * For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide per resource type. * For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, i.e. the value of the ‘claimName’ field in the Kubernetes® manifest, or a compound name built by Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own manifest. * For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of the ‘metadata.name’ field in Kubernetes® manifest. \n",
		"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.\nNOTE 1:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the CISM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. When the container infrastructure service is a KubernetesÂ® instance the vimLevelResourceType is the type of resource, as would correspond to the â€˜kindâ€™ field if the resource is declared in its own KubernetesÂ® manifest, e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition. NOTE 2:\tWhen the container infrastructure service is a KubernetesÂ® instance the resourceId shall be populated in the following way: * For a compute MCIO, it is the instance identifier that KubernetesÂ® assigns, which is unique cluster wide per resource type. * For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, i.e. the value of the â€˜claimNameâ€™ field in the KubernetesÂ® manifest, or a compound name built by KubernetesÂ® if the persistent volume claim is defined inline in another template instead of in its own manifest. * For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of the â€˜metadata.nameâ€™ field in KubernetesÂ® manifest. \n",
		"type": "object",
		"required": ["resourceId"],
		"required": [
		"resourceId"
		],
		"properties": {
		"vimId": {
		"description": "An identifier with the intention of being globally unique.\n",
		@@ -82,7 +98,11 @@
		"faultyResourceType": {
		"description": "The enumeration FaultyResourceType represents those types of faulty resource. Acceptable values are: - COMPUTE - Virtual compute resource. - STORAGE - Virtual storage resource. - NETWORK - Virtual network resource.\n",
		"type": "string",
		"enum": ["COMPUTE", "STORAGE", "NETWORK"]
		"enum": [
		"COMPUTE",
		"STORAGE",
		"NETWORK"
		]
		}
		}
		},
		@@ -109,12 +129,22 @@
		"ackState": {
		"description": "Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED\n",
		"type": "string",
		"enum": ["UNACKNOWLEDGED", "ACKNOWLEDGED"]
		"enum": [
		"UNACKNOWLEDGED",
		"ACKNOWLEDGED"
		]
		},
		"perceivedSeverity": {
		"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\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 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 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 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 severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or 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",
		"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"]
		"enum": [
		"CRITICAL",
		"MAJOR",
		"MINOR",
		"WARNING",
		"INDETERMINATE",
		"CLEARED"
		]
		},
		"eventTime": {
		"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
		@@ -122,16 +152,22 @@
		"format": "date-time"
		},
		"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\n to another (ITU-T Recommendation X.733).\n- PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733).\n- ENVIRONMENTAL_ALARM: An alarm of this type is associated with a 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 quality of a service (ITU-T Recommendation X.733).\n- EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733).\n",
		"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"]
		"enum": [
		"COMMUNICATIONS_ALARM",
		"PROCESSING_ERROR_ALARM",
		"ENVIRONMENTAL_ALARM",
		"QOS_ALARM",
		"EQUIPMENT_ALARM"
		]
		},
		"faultType": {
		"description": "Additional information to clarify the type of the fault.\n",
		"description": "Additional information to clarify the type of the fault. Valid values applicable to specific Alarms are specified as \"Alarm definition identifier\" values of the Alarm applicable to Os-Ma-nfvo reference point, as defined in clause 7.4 of ETSI GS NFV-IFA 045.\n",
		"type": "string"
		},
		"probableCause": {
		"description": "Information about the probable cause of the fault.\n",
		"description": "Information about the probable cause of the fault. Valid values applicable to specific Alarms are specified as \"Probable cause\" values of the Alarm applicable to Os-Ma-nfvo reference point, as defined in clause 7.4 of ETSI GS NFV-IFA 045.\n",
		"type": "string"
		},
		"isRootCause": {
		@@ -147,7 +183,7 @@
		}
		},
		"faultDetails": {
		"description": "Provides additional information about the fault..\n",
		"description": "Provides additional information about the fault. Valid values applicable to specific Alarms are specified as \"Fault details\" values of the Alarm applicable to Os-Ma-nfvo reference point, as defined in clause 7.4 of ETSI GS NFV-IFA 045.\n",
		"type": "array",
		"items": {
		"type": "string"
		@@ -156,12 +192,16 @@
		"_links": {
		"description": "Links for this resource.\n",
		"type": "object",
		"required": ["self"],
		"required": [
		"self"
		],
		"properties": {
		"self": {
		"description": "This type represents a link to a resource.\n",
		"type": "object",
		"required": ["href"],
		"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",

SOL005/NSFaultManagement-API/schemas/alarmNotification.schema.json

+243 −227

File changed.

Preview size limit exceeded, changes collapsed.

SOL005/NSFaultManagement-API/schemas/alarms.schema.json

+217 −178

File changed.

Preview size limit exceeded, changes collapsed.