{
  "description": "The alarm data type encapsulates information about an alarm. \nNOTE 1: For an alarm about upcoming impact due to NFVI operation and maintenance (i.e. the attribute  \n        \"faultType\" has the value \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\"), the attribute \n        \"rootCauseFaultyResource\" indicates a resource to be impacted. Further information on the upcoming\n        impact (e.g. group of impacted resources, time of impact) is provided in the attribute \"faultDetails\".\nNOTE 2: When alarms are due to upcoming NFVI operation and maintenance (i.e. the attribute \"faultType\" has the \n        value \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\"), the attribute \"faultDetails\" shall include \n        information about the anticipated time of the maintenance. See provisions under the present table.\n\nIf the attribute \"faultType\" has the value \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\", the following provisions  apply for the values of the attribute \"faultDetails\" related to changes in the state of virtualised resources:\n  - One of the entries in the array shall provide information about the anticipated time of maintenance in the \n  following format: \"anticipatedTime=$time\", wherein \"$time\" shall be formatted as a \"DateTime\", as specified \n  in ETSI GS NFV-SOL 013 [8]. \n  - One of the entries in the array shall provide identification information about the affinity/anti-affinity\n  group defined in the VNFD that is associated to the affected virtualised resource indicated by \n  \"rootCauseFaultyResource\" in the following format: \"affinityOrAntiAffinityGroupId=$group\", wherein \n  \"$group\" shall be equal to the \"affinityOrAntiAffinityGroupId\" value in the corresponding \"VduProfile\" (for a \n  VNFC/COMPUTE affected resource) or \"VirtualLinkProfile\" for a VL/NETWORK affected resource) in the \n  VNFD, which is mapped by the VNFM to the virtualised resource group identifier in the virtualised resource \n  change notification received by the VNFM from the VIM.\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"
    },
    "rootCauseFaultyResource": {
      "description": "This type represents the faulty virtual resources that have a negative impact on a VNF.\n",
      "type": "object",
      "required": ["faultyResource", "faultyResourceType"],
      "properties": {
        "faultyResource": {
          "required": ["resourceId"],
          "type": "object",
          "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
          "properties": {
            "vimConnectionId": {
              "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.\n",
              "type": "string"
            },
            "vimLevelResourceType": {
              "description": "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. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
              "type": "string"
            }
          }
        },
        "faultyResourceType": {
          "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
          "type": "string",
          "enum": ["COMPUTE", "STORAGE", "NETWORK"]
        }
      }
    },
    "alarmRaisedTime": {
      "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
      "type": "string",
      "format": "date-time"
    },
    "alarmChangedTime": {
      "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
      "type": "string",
      "format": "date-time"
    },
    "alarmClearedTime": {
      "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
      "type": "string",
      "format": "date-time"
    },
    "alarmAcknowledgedTime": {
      "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
      "type": "string",
      "format": "date-time"
    },
    "ackState": {
      "description": "Acknowledgement 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\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": "Date-time stamp. Representation: String formatted according to 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\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"
      ]
    },
    "faultType": {
      "description": "Additional information to clarify the type of the fault. If the alarm is related to changes in the state of virtualised resources  due to NFVI operation and maintenance, this attribute shall be set to  \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\".\n",
      "type": "string"
    },
    "probableCause": {
      "description": "Information about the probable cause of the fault. If the attribute \"faultType\" has the value ΓÇ£NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGEΓÇ¥, the permitted values are: \n  - \"NFVI_COMPONENT_MAINTENANCE\": Maintenance of NFVI components, e.g. \n    physical maintenance/repair, hypervisor software updates, etc.\n  - \"NFVI_COMPONENT_EVACUATION\": Evacuation of physical hosts.\n  - \"NFVI_COMPONENT_OPTIMIZATION\": Operation and management of NFVI resources, e.g.\n    to support energy efficiency or resource usage optimization.\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 \"correlatedAlarmIds\" 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. See notes 1 and 2.\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 using an absolute URI.\n",
          "type": "object",
          "required": ["href"],
          "properties": {
            "href": {
              "description": "String formatted according to IETF RFC 3986.\n",
              "type": "string"
            }
          }
        },
        "objectInstance": {
          "description": "This type represents a link to a resource using an absolute URI.\n",
          "type": "object",
          "required": ["href"],
          "properties": {
            "href": {
              "description": "String formatted according to IETF RFC 3986.\n",
              "type": "string"
            }
          }
        }
      }
    }
  }
}