cisco-expressway/json-schema/cisco-expressway-alarm-schema.json at main · api-evangelist/cisco-expressway · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-search/cisco-expressway/json-schema/cisco-expressway-alarm-schema.json",
  "title": "Cisco Expressway Alarm",
  "description": "Schema for an alarm on Cisco Expressway. Alarms indicate events or configuration changes that require administrator intervention, or hardware and environmental issues. Alarm IDs are grouped by prefix ranges: 10nnn hardware, 15nnn software, 20nnn cluster, 25nnn network, 30nnn licensing, 35nnn external services, 40nnn security, 45nnn configuration, 55nnn B2BUA, 6xxxx hybrid services, 9xxxx operational events.",
  "type": "object",
  "properties": {
    "AlarmId": {
      "type": "string",
      "description": "Unique alarm identifier. The prefix range indicates the alarm category: 10nnn for hardware failures, 15nnn for software issues, 20nnn for cluster problems, 25nnn for network configuration, 30nnn for licensing, 35nnn for external service failures, 40nnn for security, 45nnn for configuration anomalies, 55nnn for B2BUA errors, 6xxxx for hybrid services, 9xxxx for significant operational events.",
      "pattern": "^\\d{5,6}$",
      "examples": ["10001", "30001", "40001"]
    },
    "Severity": {
      "type": "string",
      "description": "Severity level of the alarm indicating the urgency of required action",
      "enum": ["Critical", "Warning", "Information"]
    },
    "Title": {
      "type": "string",
      "description": "Short description of the alarm condition",
      "examples": ["License capacity exceeded", "Certificate expiring", "Cluster communication failure"]
    },
    "Description": {
      "type": "string",
      "description": "Detailed explanation of the alarm condition and suggested remediation action"
    },
    "TimeRaised": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the alarm was raised"
    },
    "Category": {
      "type": "string",
      "description": "Category of the alarm based on the alarm ID prefix range",
      "enum": [
        "Hardware",
        "Software",
        "Cluster",
        "Network",
        "Licensing",
        "External Services",
        "Security",
        "Configuration",
        "B2BUA",
        "Hybrid Services",
        "Operational"
      ]
    }
  },
  "required": ["AlarmId", "Severity", "Title"]
}