Skip to content
alarm.schema.json 11.4 KiB
Newer Older
	"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"],
	"properties": {
		"id": {
			"description": "An identifier with the intention of being globally unique.\n",
			"type": "string"
		},
		"managedObjectId": {
			"description": "An identifier with the intention of being globally unique.\n",
			"type": "string"
		},
		"rootCauseFaultyComponent": {
			"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. NOTE:\tAt least one of the attributes shall be present.\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": "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.\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"],
					"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 the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
							"type": "string"
						},
						"vimLevelResourceType": {
							"description": "Additional resource information which is specific to this resource and its type, and which  is available from the VIM or the CISM or the resource provider. See note 1.\n",
							"type": "string"
						},
						"vimLevelAdditionalResourceInfo": {
							"description": "This type represents additional resource information which resource and resource type specific, and which  is available from the VIM or the CISM or the resource provider. NOTE:\tAt least one attribute shall be present. \n",
							"type": "object",
							"properties": {
								"hostName": {
									"description": "Name of the host where the resource is allocated. It shall be present for compute resources in the  scope of the CISM and shall be absent otherwise. See note.\n",
									"type": "string"
								},
								"persistentVolume": {
									"description": "Name of the persistent volume to which the persistent volume claim representing the storage resource is bound. It may be present for storage resources in the scope of the CISM and shall be absent otherwise.  See note.\n",
									"type": "string"
								},
								"additionalInfo": {
									"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
									"type": "object"
								}
							}
						},
						"containerNamespace": {
							"description": "The value of the namespace in which the MCIO corresponding to the resource is deployed.  This attribute shall be present if the resource is managed by a CISM and it shall be absent otherwise.\n",
							"type": "string"
						}
					}
				},
				"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"]
				}
			}
		},
		"alarmRaisedTime": {
			"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
			"type": "string",
			"format": "date-time"
		},
		"alarmChangedTime": {
			"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
			"type": "string",
			"format": "date-time"
		},
		"alarmClearedTime": {
			"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
			"type": "string",
			"format": "date-time"
		},
		"alarmAcknowledgedTime": {
			"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
			"type": "string",
			"format": "date-time"
		},
		"ackState": {
			"description": "Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED\n",
			"type": "string",
			"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",
			"type": "string",
			"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",
			"type": "string",
			"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",
			"type": "string",
			"enum": ["COMMUNICATIONS_ALARM", "PROCESSING_ERROR_ALARM", "ENVIRONMENTAL_ALARM", "QOS_ALARM", "EQUIPMENT_ALARM"]
		},
		"faultType": {
			"description": "Additional information to clarify the type of the fault.\n",
			"type": "string"
		},
		"probableCause": {
			"description": "Information about the probable cause of the fault.\n",
			"type": "string"
		},
		"isRootCause": {
			"description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
			"type": "boolean"
		},
		"correlatedAlarmIds": {
			"description": "List of identifiers of other alarms correlated to this fault.\n",
			"type": "array",
			"items": {
				"description": "An identifier with the intention of being globally unique.\n",
				"type": "string"
			}
		},
		"faultDetails": {
			"description": "Provides additional information about the fault..\n",
			"type": "array",
			"items": {
				"type": "string"
			}
		},
		"_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",
							"type": "string",
							"format": "url"
						}
					}
				}
			}
		}
	}
}