summaryrefslogtreecommitdiffstats
path: root/dcaedt_be/src/test/resources/ves-schema/CommonEventFormat_vUnresolvable.json
blob: 543996664f7ef4baa2d0ece24a42e56150889ed0 (plain)
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
{
    "$schema": "http://json-schema.org/draft-04/schema#",
	
	"definitions": {

		"otherFields": {
			"description": "additional fields not reported elsewhere",
			"type": "array",
			"items": {
				"$ref": "#/definitions/field"
			}
		},
		"requestError": {
			"description": "standard request error data structure",
			"type": "object",
			"properties": {
			    "messageId": {
					"description": "Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception",
					"type": "string"
				},
				"text": {
					"description": "Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1",
					"type": "string"
				},
				"url": {
					"description": "Hyperlink to a detailed error resource e.g., an HTML page for browser user agents",
					"type": "string"
				},
				"variables": {
					"description": "List of zero or more strings that represent the contents of the variables used by the message text",
					"type": "string"
				}
			},
			"required": [ "messageId", "text" ]
		},
		"stateChangeFields": {
			"description": "stateChange fields",
			"type": "object",
			"properties": {
				"additionalFields": {
					"description": "additional stateChange fields if needed",
					"type": "array",
					"items": {
						"$ref": "#/definitions/field"
					}
				},
				"newState": {
					"description": "new state of the entity",
					"type": "string",
					"enum": [
						"inService",
						"maintenance",
						"outOfService"
					]
				},
				"oldState": {
					"description": "previous state of the entity",
					"type": "string",
					"enum": [
						"inService",
						"maintenance",
						"outOfService"
					]
				},
				"stateChangeFieldsVersion": {
					"description": "version of the stateChangeFields block",
					"type": "number"
				},
				"stateInterface": {
					"description": "card or port name of the entity that changed state",
					"type": "string"
				}
			},
			"required": [ "newState", "oldState", "stateInterface" ]
		},
		"suppressedNvPairs": {
			"description": "List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling",
			"type": "object",
			"properties": {
				"nvPairFieldName": {
					"description": "Name of the field within which are the nvpair names to suppress",
					"type": "string"
				},
				"suppressedNvPairNames": {
					"description": "Array of nvpair names to suppress within the nvpairFieldName",
			        "type": "array",
					"items": {
					    "type": "string"
					}
				}
			},
			"required": [ "nvPairFieldName", "suppressedNvPairNames" ]
		},
		"syslogFields": {
			"description": "sysLog fields",
			"type": "object",
			"properties": {
				"additionalFields": {
					"description": "additional syslog fields if needed",
					"type": "array",
					"items": {
						"$ref": "#/definitions/field"
					}
				},
				"eventSourceHost": {
					"description": "hostname of the device",
					"type": "string"
				},
				"eventSourceType": {
					"description": "type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction",
					"type": "string"
				},
				"syslogFacility": {
					"description": "numeric code from 0 to 23 for facility--see table in documentation",
					"type": "number"
				},
				"syslogFieldsVersion": {
					"description": "version of the syslogFields block",
					"type": "number"
				},
				"syslogMsg": {
					"description": "syslog message",
					"type": "string"
				},
				"syslogPri": {
					"description": "0-192 combined severity and facility",
					"type": "number"
				},
				"syslogProc": {
					"description": "identifies the application that originated the message",
					"type": "string"
				},
				"syslogProcId": {
					"description": "a change in the value of this field indicates a discontinuity in syslog reporting",
					"type": "number"
				},
				"syslogSData": {
					"description": "syslog structured data consisting of a structured data Id followed by a set of key value pairs",
					"type": "string"
				},
				"syslogSdId": {
					"description": "0-32 char in format name@number for example ourSDID@32473",
					"type": "string"
				},
				"syslogSev": {
					"description": "numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8",
					"type": "string"
				},
				"syslogTag": {
					"description": "msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided",
					"type": "string"
				},
				"syslogVer": {
					"description": "IANA assigned version of the syslog protocol specification - typically 1",
					"type": "number"
				}
			},
			"required": [ "eventSourceType", "syslogMsg", "syslogTag" ]
		},
		"thresholdCrossingAlertFields": {
			"description": "fields specific to threshold crossing alert events",
			"type": "object",
			"properties": {
				"additionalFields": {
					"description": "additional threshold crossing alert fields if needed",
					"type": "array",
					"items": {  
						"$ref": "#/definitions/field" 
					}
				},
				"additionalParameters": {
					"description": "performance counters",
					"type": "array",
					"items": {
						"$ref": "#/definitions/counter"
					}
				},
				"alertAction": {
					"description": "Event action",
					"type": "string",
					"enum": [
						"CLEAR",
						"CONT",
						"SET"
					]
				},
				"alertDescription": {
					"description": "Unique short alert description such as IF-SHUB-ERRDROP",
					"type": "string"
				},
				"alertType": {
					"description": "Event type",
					"type": "string",
					"enum": [
						"CARD-ANOMALY",
						"ELEMENT-ANOMALY",
						"INTERFACE-ANOMALY",
						"SERVICE-ANOMALY"
					]
				},
				"alertValue": {
					"description": "Calculated API value (if applicable)",
					"type": "string"
				},
				"associatedAlertIdList": {
					"description": "List of eventIds associated with the event being reported",
					"type": "array",
					"items": { "type": "string" }
				},
				"collectionTimestamp": {
					"description": "Time when the performance collector picked up the data; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
					"type": "string"
				},
				"dataCollector": {
					"description": "Specific performance collector instance used",
					"type": "string"
				},
				"elementType": {
					"description": "type of network element - internal ATT field",
					"type": "string"
				},
				"eventSeverity": {
					"description": "event severity or priority",
					"type": "string",
					"enum": [
						"CRITICAL",
						"MAJOR",
						"MINOR",
						"WARNING",
						"NORMAL"
					]
				},
				"eventStartTimestamp": {
					"description": "Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
					"type": "string"
				},
				"interfaceName": {
					"description": "Physical or logical port or card (if applicable)",
					"type": "string"
				},
				"networkService": {
					"description": "network name - internal ATT field",
					"type": "string"
				},
				"possibleRootCause": {
					"description": "Reserved for future use",
					"type": "string"
				},
				"thresholdCrossingFieldsVersion": {
					"description": "version of the thresholdCrossingAlertFields block",
					"type": "number"
				}
			},
			"required": [
				"additionalParameters",
				"alertAction",
				"alertDescription",
				"alertType",
				"collectionTimestamp",
				"eventSeverity",
				"eventStartTimestamp"
			]
		},
		"vNicUsage": {
			"description": "usage of identified virtual network interface card",
			"type": "object",
			"properties": {
				"broadcastPacketsIn": { "type": "number" },
				"broadcastPacketsOut": { "type": "number" },
				"bytesIn": { "type": "number" },
				"bytesOut": { "type": "number" },
				"multicastPacketsIn": { "type": "number" },
				"multicastPacketsOut": { "type": "number" },
				"packetsIn": { "type": "number" },
				"packetsOut": { "type": "number" },
				"unicastPacketsIn": { "type": "number" },
				"unicastPacketsOut": { "type": "number" },
				"vNicIdentifier": { "type": "string" }
			},
			"required": [ "bytesIn", "bytesOut", "packetsIn", "packetsOut", "vNicIdentifier"]
		}
	},
	"title": "Event Listener",
	"type": "object",
	"properties": {
        "event": {"$ref": "#/definitions/event"}
    }
}