DCAE-D be initial commit
[sdc/dcae-d/dt-be-main.git] / dcaedt_be / src / test / resources / ves-schema / CommonEventFormat_vUnresolvable.json
1 {
2     "$schema": "http://json-schema.org/draft-04/schema#",
3         
4         "definitions": {
5
6                 "otherFields": {
7                         "description": "additional fields not reported elsewhere",
8                         "type": "array",
9                         "items": {
10                                 "$ref": "#/definitions/field"
11                         }
12                 },
13                 "requestError": {
14                         "description": "standard request error data structure",
15                         "type": "object",
16                         "properties": {
17                             "messageId": {
18                                         "description": "Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception",
19                                         "type": "string"
20                                 },
21                                 "text": {
22                                         "description": "Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1",
23                                         "type": "string"
24                                 },
25                                 "url": {
26                                         "description": "Hyperlink to a detailed error resource e.g., an HTML page for browser user agents",
27                                         "type": "string"
28                                 },
29                                 "variables": {
30                                         "description": "List of zero or more strings that represent the contents of the variables used by the message text",
31                                         "type": "string"
32                                 }
33                         },
34                         "required": [ "messageId", "text" ]
35                 },
36                 "stateChangeFields": {
37                         "description": "stateChange fields",
38                         "type": "object",
39                         "properties": {
40                                 "additionalFields": {
41                                         "description": "additional stateChange fields if needed",
42                                         "type": "array",
43                                         "items": {
44                                                 "$ref": "#/definitions/field"
45                                         }
46                                 },
47                                 "newState": {
48                                         "description": "new state of the entity",
49                                         "type": "string",
50                                         "enum": [
51                                                 "inService",
52                                                 "maintenance",
53                                                 "outOfService"
54                                         ]
55                                 },
56                                 "oldState": {
57                                         "description": "previous state of the entity",
58                                         "type": "string",
59                                         "enum": [
60                                                 "inService",
61                                                 "maintenance",
62                                                 "outOfService"
63                                         ]
64                                 },
65                                 "stateChangeFieldsVersion": {
66                                         "description": "version of the stateChangeFields block",
67                                         "type": "number"
68                                 },
69                                 "stateInterface": {
70                                         "description": "card or port name of the entity that changed state",
71                                         "type": "string"
72                                 }
73                         },
74                         "required": [ "newState", "oldState", "stateInterface" ]
75                 },
76                 "suppressedNvPairs": {
77                         "description": "List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling",
78                         "type": "object",
79                         "properties": {
80                                 "nvPairFieldName": {
81                                         "description": "Name of the field within which are the nvpair names to suppress",
82                                         "type": "string"
83                                 },
84                                 "suppressedNvPairNames": {
85                                         "description": "Array of nvpair names to suppress within the nvpairFieldName",
86                                 "type": "array",
87                                         "items": {
88                                             "type": "string"
89                                         }
90                                 }
91                         },
92                         "required": [ "nvPairFieldName", "suppressedNvPairNames" ]
93                 },
94                 "syslogFields": {
95                         "description": "sysLog fields",
96                         "type": "object",
97                         "properties": {
98                                 "additionalFields": {
99                                         "description": "additional syslog fields if needed",
100                                         "type": "array",
101                                         "items": {
102                                                 "$ref": "#/definitions/field"
103                                         }
104                                 },
105                                 "eventSourceHost": {
106                                         "description": "hostname of the device",
107                                         "type": "string"
108                                 },
109                                 "eventSourceType": {
110                                         "description": "type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction",
111                                         "type": "string"
112                                 },
113                                 "syslogFacility": {
114                                         "description": "numeric code from 0 to 23 for facility--see table in documentation",
115                                         "type": "number"
116                                 },
117                                 "syslogFieldsVersion": {
118                                         "description": "version of the syslogFields block",
119                                         "type": "number"
120                                 },
121                                 "syslogMsg": {
122                                         "description": "syslog message",
123                                         "type": "string"
124                                 },
125                                 "syslogPri": {
126                                         "description": "0-192 combined severity and facility",
127                                         "type": "number"
128                                 },
129                                 "syslogProc": {
130                                         "description": "identifies the application that originated the message",
131                                         "type": "string"
132                                 },
133                                 "syslogProcId": {
134                                         "description": "a change in the value of this field indicates a discontinuity in syslog reporting",
135                                         "type": "number"
136                                 },
137                                 "syslogSData": {
138                                         "description": "syslog structured data consisting of a structured data Id followed by a set of key value pairs",
139                                         "type": "string"
140                                 },
141                                 "syslogSdId": {
142                                         "description": "0-32 char in format name@number for example ourSDID@32473",
143                                         "type": "string"
144                                 },
145                                 "syslogSev": {
146                                         "description": "numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8",
147                                         "type": "string"
148                                 },
149                                 "syslogTag": {
150                                         "description": "msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided",
151                                         "type": "string"
152                                 },
153                                 "syslogVer": {
154                                         "description": "IANA assigned version of the syslog protocol specification - typically 1",
155                                         "type": "number"
156                                 }
157                         },
158                         "required": [ "eventSourceType", "syslogMsg", "syslogTag" ]
159                 },
160                 "thresholdCrossingAlertFields": {
161                         "description": "fields specific to threshold crossing alert events",
162                         "type": "object",
163                         "properties": {
164                                 "additionalFields": {
165                                         "description": "additional threshold crossing alert fields if needed",
166                                         "type": "array",
167                                         "items": {  
168                                                 "$ref": "#/definitions/field" 
169                                         }
170                                 },
171                                 "additionalParameters": {
172                                         "description": "performance counters",
173                                         "type": "array",
174                                         "items": {
175                                                 "$ref": "#/definitions/counter"
176                                         }
177                                 },
178                                 "alertAction": {
179                                         "description": "Event action",
180                                         "type": "string",
181                                         "enum": [
182                                                 "CLEAR",
183                                                 "CONT",
184                                                 "SET"
185                                         ]
186                                 },
187                                 "alertDescription": {
188                                         "description": "Unique short alert description such as IF-SHUB-ERRDROP",
189                                         "type": "string"
190                                 },
191                                 "alertType": {
192                                         "description": "Event type",
193                                         "type": "string",
194                                         "enum": [
195                                                 "CARD-ANOMALY",
196                                                 "ELEMENT-ANOMALY",
197                                                 "INTERFACE-ANOMALY",
198                                                 "SERVICE-ANOMALY"
199                                         ]
200                                 },
201                                 "alertValue": {
202                                         "description": "Calculated API value (if applicable)",
203                                         "type": "string"
204                                 },
205                                 "associatedAlertIdList": {
206                                         "description": "List of eventIds associated with the event being reported",
207                                         "type": "array",
208                                         "items": { "type": "string" }
209                                 },
210                                 "collectionTimestamp": {
211                                         "description": "Time when the performance collector picked up the data; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
212                                         "type": "string"
213                                 },
214                                 "dataCollector": {
215                                         "description": "Specific performance collector instance used",
216                                         "type": "string"
217                                 },
218                                 "elementType": {
219                                         "description": "type of network element - internal ATT field",
220                                         "type": "string"
221                                 },
222                                 "eventSeverity": {
223                                         "description": "event severity or priority",
224                                         "type": "string",
225                                         "enum": [
226                                                 "CRITICAL",
227                                                 "MAJOR",
228                                                 "MINOR",
229                                                 "WARNING",
230                                                 "NORMAL"
231                                         ]
232                                 },
233                                 "eventStartTimestamp": {
234                                         "description": "Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
235                                         "type": "string"
236                                 },
237                                 "interfaceName": {
238                                         "description": "Physical or logical port or card (if applicable)",
239                                         "type": "string"
240                                 },
241                                 "networkService": {
242                                         "description": "network name - internal ATT field",
243                                         "type": "string"
244                                 },
245                                 "possibleRootCause": {
246                                         "description": "Reserved for future use",
247                                         "type": "string"
248                                 },
249                                 "thresholdCrossingFieldsVersion": {
250                                         "description": "version of the thresholdCrossingAlertFields block",
251                                         "type": "number"
252                                 }
253                         },
254                         "required": [
255                                 "additionalParameters",
256                                 "alertAction",
257                                 "alertDescription",
258                                 "alertType",
259                                 "collectionTimestamp",
260                                 "eventSeverity",
261                                 "eventStartTimestamp"
262                         ]
263                 },
264                 "vNicUsage": {
265                         "description": "usage of identified virtual network interface card",
266                         "type": "object",
267                         "properties": {
268                                 "broadcastPacketsIn": { "type": "number" },
269                                 "broadcastPacketsOut": { "type": "number" },
270                                 "bytesIn": { "type": "number" },
271                                 "bytesOut": { "type": "number" },
272                                 "multicastPacketsIn": { "type": "number" },
273                                 "multicastPacketsOut": { "type": "number" },
274                                 "packetsIn": { "type": "number" },
275                                 "packetsOut": { "type": "number" },
276                                 "unicastPacketsIn": { "type": "number" },
277                                 "unicastPacketsOut": { "type": "number" },
278                                 "vNicIdentifier": { "type": "string" }
279                         },
280                         "required": [ "bytesIn", "bytesOut", "packetsIn", "packetsOut", "vNicIdentifier"]
281                 }
282         },
283         "title": "Event Listener",
284         "type": "object",
285         "properties": {
286         "event": {"$ref": "#/definitions/event"}
287     }
288 }