Gitiles
Code Review Sign In
gerrit.nordix.org / onap / dcaegen2 / 6553a13f948ffbf48c3bf5ec723372df137a085c / . / docs / sections / apis / ves.rst
blob: 41d903bed322574b6ca4a92dc126b5b7c57a5179 [file] [log] [blame]
Lusheng Ji6553a132017-10-12 02:47:00 +0000[diff] [blame^]1VES Collector 1.1.0
2===================
3
4.. toctree::
5 :maxdepth: 3
6
7
8Description
9~~~~~~~~~~~
10
11Virtual Event Streaming (VES) Collector is RESTful collector for processing JSON messages. The collector verifies the source and validates the events against VES schema before distributing to DMAAP MR topics
12
13
14
15
16Contact Information
17~~~~~~~~~~~~~~~~~~~
18
19
20
21dcae@lists.openecomp.org
22
23
24
25
26
27
28Security
29~~~~~~~~
30
31
32.. _securities_basicAuth:
33
34basicAuth (HTTP Basic Authentication)
35-------------------------------------
36
37
38*HTTP Basic Authentication. Works over `HTTP` and `HTTPS`*
39
40
41
42
43
44DEFAULT
45~~~~~~~
46
47
48
49
50GET ``/healthcheck``
51--------------------
52
53
54
55
56
57Request
58+++++++
59
60
61Responses
62+++++++++
63
64**200**
65^^^^^^^
66
67healthcheck successful
68
69
70
71
72
73
74POST ``/eventListener/v5``
75--------------------------
76
77
78
79Description
80+++++++++++
81
82.. raw:: html
83
84 uri for posting VES event objects
85
86
87Request
88+++++++
89
90
91
92.. _d_f598222d7a83ca9c3538556b263682d1:
93
94Body
95^^^^
96
97.. csv-table::
98 :delim: |
99 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
100 :widths: 20, 10, 15, 15, 30, 25
101
102 event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
103
104.. code-block:: javascript
105
106 {
107 "event": {
108 "commonEventHeader": {
109 "domain": "fault",
110 "eventId": "somestring",
111 "eventName": "somestring",
112 "eventType": "somestring",
113 "internalHeaderFields": {},
114 "lastEpochMicrosec": 1,
115 "nfNamingCode": "somestring",
116 "nfcNamingCode": "somestring",
117 "priority": "High",
118 "reportingEntityId": "somestring",
119 "reportingEntityName": "somestring",
120 "sequence": 1,
121 "sourceId": "somestring",
122 "sourceName": "somestring",
123 "startEpochMicrosec": 1,
124 "version": 1
125 },
126 "faultFields": {
127 "alarmAdditionalInformation": [
128 {
129 "name": "somestring",
130 "value": "somestring"
131 },
132 {
133 "name": "somestring",
134 "value": "somestring"
135 }
136 ],
137 "alarmCondition": "somestring",
138 "alarmInterfaceA": "somestring",
139 "eventCategory": "somestring",
140 "eventSeverity": "CRITICAL",
141 "eventSourceType": "somestring",
142 "faultFieldsVersion": 1,
143 "specificProblem": "somestring",
144 "vfStatus": "Active"
145 },
146 "heartbeatFields": {
147 "additionalFields": [
148 {
149 "name": "somestring",
150 "value": "somestring"
151 },
152 {
153 "name": "somestring",
154 "value": "somestring"
155 }
156 ],
157 "heartbeatFieldsVersion": 1,
158 "heartbeatInterval": 1
159 },
160 "measurementsForVfScalingFields": {
161 "additionalFields": [
162 {
163 "name": "somestring",
164 "value": "somestring"
165 },
166 {
167 "name": "somestring",
168 "value": "somestring"
169 }
170 ],
171 "additionalMeasurements": [
172 {
173 "arrayOfFields": [
174 {
175 "name": "somestring",
176 "value": "somestring"
177 },
178 {
179 "name": "somestring",
180 "value": "somestring"
181 }
182 ],
183 "name": "somestring"
184 },
185 {
186 "arrayOfFields": [
187 {
188 "name": "somestring",
189 "value": "somestring"
190 },
191 {
192 "name": "somestring",
193 "value": "somestring"
194 }
195 ],
196 "name": "somestring"
197 }
198 ],
199 "additionalObjects": [
200 {
201 "nfSubscribedObjectName": "somestring",
202 "nfSubscriptionId": "somestring",
203 "objectInstances": [
204 {
205 "objectInstance": {},
206 "objectInstanceEpochMicrosec": 1,
207 "objectKeys": [
208 {
209 "keyName": "somestring",
210 "keyOrder": 1,
211 "keyValue": "somestring"
212 },
213 {
214 "keyName": "somestring",
215 "keyOrder": 1,
216 "keyValue": "somestring"
217 }
218 ]
219 },
220 {
221 "objectInstance": {},
222 "objectInstanceEpochMicrosec": 1,
223 "objectKeys": [
224 {
225 "keyName": "somestring",
226 "keyOrder": 1,
227 "keyValue": "somestring"
228 },
229 {
230 "keyName": "somestring",
231 "keyOrder": 1,
232 "keyValue": "somestring"
233 }
234 ]
235 }
236 ],
237 "objectName": "somestring",
238 "objectSchema": "somestring",
239 "objectSchemaUrl": "somestring"
240 },
241 {
242 "nfSubscribedObjectName": "somestring",
243 "nfSubscriptionId": "somestring",
244 "objectInstances": [
245 {
246 "objectInstance": {},
247 "objectInstanceEpochMicrosec": 1,
248 "objectKeys": [
249 {
250 "keyName": "somestring",
251 "keyOrder": 1,
252 "keyValue": "somestring"
253 },
254 {
255 "keyName": "somestring",
256 "keyOrder": 1,
257 "keyValue": "somestring"
258 }
259 ]
260 },
261 {
262 "objectInstance": {},
263 "objectInstanceEpochMicrosec": 1,
264 "objectKeys": [
265 {
266 "keyName": "somestring",
267 "keyOrder": 1,
268 "keyValue": "somestring"
269 },
270 {
271 "keyName": "somestring",
272 "keyOrder": 1,
273 "keyValue": "somestring"
274 }
275 ]
276 }
277 ],
278 "objectName": "somestring",
279 "objectSchema": "somestring",
280 "objectSchemaUrl": "somestring"
281 }
282 ],
283 "codecUsageArray": [
284 {
285 "codecIdentifier": "somestring",
286 "numberInUse": 1
287 },
288 {
289 "codecIdentifier": "somestring",
290 "numberInUse": 1
291 }
292 ],
293 "concurrentSessions": 1,
294 "configuredEntities": 1,
295 "cpuUsageArray": [
296 {
297 "cpuIdentifier": "somestring",
298 "cpuIdle": 1,
299 "cpuUsageInterrupt": 1,
300 "cpuUsageNice": 1,
301 "cpuUsageSoftIrq": 1,
302 "cpuUsageSteal": 1,
303 "cpuUsageSystem": 1,
304 "cpuUsageUser": 1,
305 "cpuWait": 1,
306 "percentUsage": 1
307 },
308 {
309 "cpuIdentifier": "somestring",
310 "cpuIdle": 1,
311 "cpuUsageInterrupt": 1,
312 "cpuUsageNice": 1,
313 "cpuUsageSoftIrq": 1,
314 "cpuUsageSteal": 1,
315 "cpuUsageSystem": 1,
316 "cpuUsageUser": 1,
317 "cpuWait": 1,
318 "percentUsage": 1
319 }
320 ],
321 "diskUsageArray": [
322 {
323 "diskIdentifier": "somestring",
324 "diskIoTimeAvg": 1,
325 "diskIoTimeLast": 1,
326 "diskIoTimeMax": 1,
327 "diskIoTimeMin": 1,
328 "diskMergedReadAvg": 1,
329 "diskMergedReadLast": 1,
330 "diskMergedReadMax": 1,
331 "diskMergedReadMin": 1,
332 "diskMergedWriteAvg": 1,
333 "diskMergedWriteLast": 1,
334 "diskMergedWriteMax": 1,
335 "diskMergedWriteMin": 1,
336 "diskOctetsReadAvg": 1,
337 "diskOctetsReadLast": 1,
338 "diskOctetsReadMax": 1,
339 "diskOctetsReadMin": 1,
340 "diskOctetsWriteAvg": 1,
341 "diskOctetsWriteLast": 1,
342 "diskOctetsWriteMax": 1,
343 "diskOctetsWriteMin": 1,
344 "diskOpsReadAvg": 1,
345 "diskOpsReadLast": 1,
346 "diskOpsReadMax": 1,
347 "diskOpsReadMin": 1,
348 "diskOpsWriteAvg": 1,
349 "diskOpsWriteLast": 1,
350 "diskOpsWriteMax": 1,
351 "diskOpsWriteMin": 1,
352 "diskPendingOperationsAvg": 1,
353 "diskPendingOperationsLast": 1,
354 "diskPendingOperationsMax": 1,
355 "diskPendingOperationsMin": 1,
356 "diskTimeReadAvg": 1,
357 "diskTimeReadLast": 1,
358 "diskTimeReadMax": 1,
359 "diskTimeReadMin": 1,
360 "diskTimeWriteAvg": 1,
361 "diskTimeWriteLast": 1,
362 "diskTimeWriteMax": 1,
363 "diskTimeWriteMin": 1
364 },
365 {
366 "diskIdentifier": "somestring",
367 "diskIoTimeAvg": 1,
368 "diskIoTimeLast": 1,
369 "diskIoTimeMax": 1,
370 "diskIoTimeMin": 1,
371 "diskMergedReadAvg": 1,
372 "diskMergedReadLast": 1,
373 "diskMergedReadMax": 1,
374 "diskMergedReadMin": 1,
375 "diskMergedWriteAvg": 1,
376 "diskMergedWriteLast": 1,
377 "diskMergedWriteMax": 1,
378 "diskMergedWriteMin": 1,
379 "diskOctetsReadAvg": 1,
380 "diskOctetsReadLast": 1,
381 "diskOctetsReadMax": 1,
382 "diskOctetsReadMin": 1,
383 "diskOctetsWriteAvg": 1,
384 "diskOctetsWriteLast": 1,
385 "diskOctetsWriteMax": 1,
386 "diskOctetsWriteMin": 1,
387 "diskOpsReadAvg": 1,
388 "diskOpsReadLast": 1,
389 "diskOpsReadMax": 1,
390 "diskOpsReadMin": 1,
391 "diskOpsWriteAvg": 1,
392 "diskOpsWriteLast": 1,
393 "diskOpsWriteMax": 1,
394 "diskOpsWriteMin": 1,
395 "diskPendingOperationsAvg": 1,
396 "diskPendingOperationsLast": 1,
397 "diskPendingOperationsMax": 1,
398 "diskPendingOperationsMin": 1,
399 "diskTimeReadAvg": 1,
400 "diskTimeReadLast": 1,
401 "diskTimeReadMax": 1,
402 "diskTimeReadMin": 1,
403 "diskTimeWriteAvg": 1,
404 "diskTimeWriteLast": 1,
405 "diskTimeWriteMax": 1,
406 "diskTimeWriteMin": 1
407 }
408 ],
409 "featureUsageArray": [
410 {
411 "featureIdentifier": "somestring",
412 "featureUtilization": 1
413 },
414 {
415 "featureIdentifier": "somestring",
416 "featureUtilization": 1
417 }
418 ],
419 "filesystemUsageArray": [
420 {
421 "blockConfigured": 1,
422 "blockIops": 1,
423 "blockUsed": 1,
424 "ephemeralConfigured": 1,
425 "ephemeralIops": 1,
426 "ephemeralUsed": 1,
427 "filesystemName": "somestring"
428 },
429 {
430 "blockConfigured": 1,
431 "blockIops": 1,
432 "blockUsed": 1,
433 "ephemeralConfigured": 1,
434 "ephemeralIops": 1,
435 "ephemeralUsed": 1,
436 "filesystemName": "somestring"
437 }
438 ],
439 "latencyDistribution": [
440 {
441 "countsInTheBucket": 1,
442 "highEndOfLatencyBucket": 1,
443 "lowEndOfLatencyBucket": 1
444 },
445 {
446 "countsInTheBucket": 1,
447 "highEndOfLatencyBucket": 1,
448 "lowEndOfLatencyBucket": 1
449 }
450 ],
451 "meanRequestLatency": 1,
452 "measurementInterval": 1,
453 "measurementsForVfScalingVersion": 1,
454 "memoryUsageArray": [
455 {
456 "memoryBuffered": 1,
457 "memoryCached": 1,
458 "memoryConfigured": 1,
459 "memoryFree": 1,
460 "memorySlabRecl": 1,
461 "memorySlabUnrecl": 1,
462 "memoryUsed": 1,
463 "vmIdentifier": "somestring"
464 },
465 {
466 "memoryBuffered": 1,
467 "memoryCached": 1,
468 "memoryConfigured": 1,
469 "memoryFree": 1,
470 "memorySlabRecl": 1,
471 "memorySlabUnrecl": 1,
472 "memoryUsed": 1,
473 "vmIdentifier": "somestring"
474 }
475 ],
476 "numberOfMediaPortsInUse": 1,
477 "requestRate": 1,
478 "vNicPerformanceArray": [
479 {
480 "receivedBroadcastPacketsAccumulated": 1,
481 "receivedBroadcastPacketsDelta": 1,
482 "receivedDiscardedPacketsAccumulated": 1,
483 "receivedDiscardedPacketsDelta": 1,
484 "receivedErrorPacketsAccumulated": 1,
485 "receivedErrorPacketsDelta": 1,
486 "receivedMulticastPacketsAccumulated": 1,
487 "receivedMulticastPacketsDelta": 1,
488 "receivedOctetsAccumulated": 1,
489 "receivedOctetsDelta": 1,
490 "receivedTotalPacketsAccumulated": 1,
491 "receivedTotalPacketsDelta": 1,
492 "receivedUnicastPacketsAccumulated": 1,
493 "receivedUnicastPacketsDelta": 1,
494 "transmittedBroadcastPacketsAccumulated": 1,
495 "transmittedBroadcastPacketsDelta": 1,
496 "transmittedDiscardedPacketsAccumulated": 1,
497 "transmittedDiscardedPacketsDelta": 1,
498 "transmittedErrorPacketsAccumulated": 1,
499 "transmittedErrorPacketsDelta": 1,
500 "transmittedMulticastPacketsAccumulated": 1,
501 "transmittedMulticastPacketsDelta": 1,
502 "transmittedOctetsAccumulated": 1,
503 "transmittedOctetsDelta": 1,
504 "transmittedTotalPacketsAccumulated": 1,
505 "transmittedTotalPacketsDelta": 1,
506 "transmittedUnicastPacketsAccumulated": 1,
507 "transmittedUnicastPacketsDelta": 1,
508 "vNicIdentifier": "somestring",
509 "valuesAreSuspect": "true"
510 },
511 {
512 "receivedBroadcastPacketsAccumulated": 1,
513 "receivedBroadcastPacketsDelta": 1,
514 "receivedDiscardedPacketsAccumulated": 1,
515 "receivedDiscardedPacketsDelta": 1,
516 "receivedErrorPacketsAccumulated": 1,
517 "receivedErrorPacketsDelta": 1,
518 "receivedMulticastPacketsAccumulated": 1,
519 "receivedMulticastPacketsDelta": 1,
520 "receivedOctetsAccumulated": 1,
521 "receivedOctetsDelta": 1,
522 "receivedTotalPacketsAccumulated": 1,
523 "receivedTotalPacketsDelta": 1,
524 "receivedUnicastPacketsAccumulated": 1,
525 "receivedUnicastPacketsDelta": 1,
526 "transmittedBroadcastPacketsAccumulated": 1,
527 "transmittedBroadcastPacketsDelta": 1,
528 "transmittedDiscardedPacketsAccumulated": 1,
529 "transmittedDiscardedPacketsDelta": 1,
530 "transmittedErrorPacketsAccumulated": 1,
531 "transmittedErrorPacketsDelta": 1,
532 "transmittedMulticastPacketsAccumulated": 1,
533 "transmittedMulticastPacketsDelta": 1,
534 "transmittedOctetsAccumulated": 1,
535 "transmittedOctetsDelta": 1,
536 "transmittedTotalPacketsAccumulated": 1,
537 "transmittedTotalPacketsDelta": 1,
538 "transmittedUnicastPacketsAccumulated": 1,
539 "transmittedUnicastPacketsDelta": 1,
540 "vNicIdentifier": "somestring",
541 "valuesAreSuspect": "true"
542 }
543 ],
544 "vnfcScalingMetric": 1
545 },
546 "mobileFlowFields": {
547 "additionalFields": [
548 {
549 "name": "somestring",
550 "value": "somestring"
551 },
552 {
553 "name": "somestring",
554 "value": "somestring"
555 }
556 ],
557 "appProtocolType": "somestring",
558 "appProtocolVersion": "somestring",
559 "applicationType": "somestring",
560 "cid": "somestring",
561 "connectionType": "somestring",
562 "ecgi": "somestring",
563 "flowDirection": "somestring",
564 "gtpPerFlowMetrics": {
565 "avgBitErrorRate": 1,
566 "avgPacketDelayVariation": 1,
567 "avgPacketLatency": 1,
568 "avgReceiveThroughput": 1,
569 "avgTransmitThroughput": 1,
570 "durConnectionFailedStatus": 1,
571 "durTunnelFailedStatus": 1,
572 "flowActivatedBy": "somestring",
573 "flowActivationEpoch": 1,
574 "flowActivationMicrosec": 1,
575 "flowActivationTime": "somestring",
576 "flowDeactivatedBy": "somestring",
577 "flowDeactivationEpoch": 1,
578 "flowDeactivationMicrosec": 1,
579 "flowDeactivationTime": "somestring",
580 "flowStatus": "somestring",
581 "gtpConnectionStatus": "somestring",
582 "gtpTunnelStatus": "somestring",
583 "ipTosCountList": [
584 [
585 1,
586 1
587 ],
588 [
589 1,
590 1
591 ]
592 ],
593 "ipTosList": [
594 "somestring",
595 "somestring"
596 ],
597 "largePacketRtt": 1,
598 "largePacketThreshold": 1,
599 "maxPacketDelayVariation": 1,
600 "maxReceiveBitRate": 1,
601 "maxTransmitBitRate": 1,
602 "mobileQciCosCountList": [
603 [
604 1,
605 1
606 ],
607 [
608 1,
609 1
610 ]
611 ],
612 "mobileQciCosList": [
613 "somestring",
614 "somestring"
615 ],
616 "numActivationFailures": 1,
617 "numBitErrors": 1,
618 "numBytesReceived": 1,
619 "numBytesTransmitted": 1,
620 "numDroppedPackets": 1,
621 "numGtpEchoFailures": 1,
622 "numGtpTunnelErrors": 1,
623 "numHttpErrors": 1,
624 "numL7BytesReceived": 1,
625 "numL7BytesTransmitted": 1,
626 "numLostPackets": 1,
627 "numOutOfOrderPackets": 1,
628 "numPacketErrors": 1,
629 "numPacketsReceivedExclRetrans": 1,
630 "numPacketsReceivedInclRetrans": 1,
631 "numPacketsTransmittedInclRetrans": 1,
632 "numRetries": 1,
633 "numTimeouts": 1,
634 "numTunneledL7BytesReceived": 1,
635 "roundTripTime": 1,
636 "tcpFlagCountList": [
637 [
638 1,
639 1
640 ],
641 [
642 1,
643 1
644 ]
645 ],
646 "tcpFlagList": [
647 "somestring",
648 "somestring"
649 ],
650 "timeToFirstByte": 1
651 },
652 "gtpProtocolType": "somestring",
653 "gtpVersion": "somestring",
654 "httpHeader": "somestring",
655 "imei": "somestring",
656 "imsi": "somestring",
657 "ipProtocolType": "somestring",
658 "ipVersion": "somestring",
659 "lac": "somestring",
660 "mcc": "somestring",
661 "mnc": "somestring",
662 "mobileFlowFieldsVersion": 1,
663 "msisdn": "somestring",
664 "otherEndpointIpAddress": "somestring",
665 "otherEndpointPort": 1,
666 "otherFunctionalRole": "somestring",
667 "rac": "somestring",
668 "radioAccessTechnology": "somestring",
669 "reportingEndpointIpAddr": "somestring",
670 "reportingEndpointPort": 1,
671 "sac": "somestring",
672 "samplingAlgorithm": 1,
673 "tac": "somestring",
674 "tunnelId": "somestring",
675 "vlanId": "somestring"
676 },
677 "otherFields": {
678 "hashOfNameValuePairArrays": [
679 {
680 "arrayOfFields": [
681 {
682 "name": "somestring",
683 "value": "somestring"
684 },
685 {
686 "name": "somestring",
687 "value": "somestring"
688 }
689 ],
690 "name": "somestring"
691 },
692 {
693 "arrayOfFields": [
694 {
695 "name": "somestring",
696 "value": "somestring"
697 },
698 {
699 "name": "somestring",
700 "value": "somestring"
701 }
702 ],
703 "name": "somestring"
704 }
705 ],
706 "jsonObjects": [
707 {
708 "nfSubscribedObjectName": "somestring",
709 "nfSubscriptionId": "somestring",
710 "objectInstances": [
711 {
712 "objectInstance": {},
713 "objectInstanceEpochMicrosec": 1,
714 "objectKeys": [
715 {
716 "keyName": "somestring",
717 "keyOrder": 1,
718 "keyValue": "somestring"
719 },
720 {
721 "keyName": "somestring",
722 "keyOrder": 1,
723 "keyValue": "somestring"
724 }
725 ]
726 },
727 {
728 "objectInstance": {},
729 "objectInstanceEpochMicrosec": 1,
730 "objectKeys": [
731 {
732 "keyName": "somestring",
733 "keyOrder": 1,
734 "keyValue": "somestring"
735 },
736 {
737 "keyName": "somestring",
738 "keyOrder": 1,
739 "keyValue": "somestring"
740 }
741 ]
742 }
743 ],
744 "objectName": "somestring",
745 "objectSchema": "somestring",
746 "objectSchemaUrl": "somestring"
747 },
748 {
749 "nfSubscribedObjectName": "somestring",
750 "nfSubscriptionId": "somestring",
751 "objectInstances": [
752 {
753 "objectInstance": {},
754 "objectInstanceEpochMicrosec": 1,
755 "objectKeys": [
756 {
757 "keyName": "somestring",
758 "keyOrder": 1,
759 "keyValue": "somestring"
760 },
761 {
762 "keyName": "somestring",
763 "keyOrder": 1,
764 "keyValue": "somestring"
765 }
766 ]
767 },
768 {
769 "objectInstance": {},
770 "objectInstanceEpochMicrosec": 1,
771 "objectKeys": [
772 {
773 "keyName": "somestring",
774 "keyOrder": 1,
775 "keyValue": "somestring"
776 },
777 {
778 "keyName": "somestring",
779 "keyOrder": 1,
780 "keyValue": "somestring"
781 }
782 ]
783 }
784 ],
785 "objectName": "somestring",
786 "objectSchema": "somestring",
787 "objectSchemaUrl": "somestring"
788 }
789 ],
790 "nameValuePairs": [
791 {
792 "name": "somestring",
793 "value": "somestring"
794 },
795 {
796 "name": "somestring",
797 "value": "somestring"
798 }
799 ],
800 "otherFieldsVersion": 1
801 },
802 "sipSignalingFields": {
803 "additionalInformation": [
804 {
805 "name": "somestring",
806 "value": "somestring"
807 },
808 {
809 "name": "somestring",
810 "value": "somestring"
811 }
812 ],
813 "compressedSip": "somestring",
814 "correlator": "somestring",
815 "localIpAddress": "somestring",
816 "localPort": "somestring",
817 "remoteIpAddress": "somestring",
818 "remotePort": "somestring",
819 "sipSignalingFieldsVersion": 1,
820 "summarySip": "somestring",
821 "vendorVnfNameFields": {
822 "vendorName": "somestring",
823 "vfModuleName": "somestring",
824 "vnfName": "somestring"
825 }
826 },
827 "stateChangeFields": {
828 "additionalFields": [
829 {
830 "name": "somestring",
831 "value": "somestring"
832 },
833 {
834 "name": "somestring",
835 "value": "somestring"
836 }
837 ],
838 "newState": "inService",
839 "oldState": "inService",
840 "stateChangeFieldsVersion": 1,
841 "stateInterface": "somestring"
842 },
843 "syslogFields": {
844 "additionalFields": "somestring",
845 "eventSourceHost": "somestring",
846 "eventSourceType": "somestring",
847 "syslogFacility": 1,
848 "syslogFieldsVersion": 1,
849 "syslogMsg": "somestring",
850 "syslogPri": 1,
851 "syslogProc": "somestring",
852 "syslogProcId": 1,
853 "syslogSData": "somestring",
854 "syslogSdId": "somestring",
855 "syslogSev": "Alert",
856 "syslogTag": "somestring",
857 "syslogVer": 1
858 },
859 "thresholdCrossingAlertFields": {
860 "additionalFields": [
861 {
862 "name": "somestring",
863 "value": "somestring"
864 },
865 {
866 "name": "somestring",
867 "value": "somestring"
868 }
869 ],
870 "additionalParameters": [
871 {
872 "criticality": "CRIT",
873 "name": "somestring",
874 "thresholdCrossed": "somestring",
875 "value": "somestring"
876 },
877 {
878 "criticality": "CRIT",
879 "name": "somestring",
880 "thresholdCrossed": "somestring",
881 "value": "somestring"
882 }
883 ],
884 "alertAction": "CLEAR",
885 "alertDescription": "somestring",
886 "alertType": "CARD-ANOMALY",
887 "alertValue": "somestring",
888 "associatedAlertIdList": [
889 "somestring",
890 "somestring"
891 ],
892 "collectionTimestamp": "somestring",
893 "dataCollector": "somestring",
894 "elementType": "somestring",
895 "eventSeverity": "CRITICAL",
896 "eventStartTimestamp": "somestring",
897 "interfaceName": "somestring",
898 "networkService": "somestring",
899 "possibleRootCause": "somestring",
900 "thresholdCrossingFieldsVersion": 1
901 },
902 "voiceQualityFields": {
903 "additionalInformation": [
904 {
905 "name": "somestring",
906 "value": "somestring"
907 },
908 {
909 "name": "somestring",
910 "value": "somestring"
911 }
912 ],
913 "calleeSideCodec": "somestring",
914 "callerSideCodec": "somestring",
915 "correlator": "somestring",
916 "endOfCallVqmSummaries": {
917 "adjacencyName": "somestring",
918 "endpointDescription": "Caller",
919 "endpointJitter": 1,
920 "endpointRtpOctetsDiscarded": 1,
921 "endpointRtpOctetsReceived": 1,
922 "endpointRtpOctetsSent": 1,
923 "endpointRtpPacketsDiscarded": 1,
924 "endpointRtpPacketsReceived": 1,
925 "endpointRtpPacketsSent": 1,
926 "localJitter": 1,
927 "localRtpOctetsDiscarded": 1,
928 "localRtpOctetsReceived": 1,
929 "localRtpOctetsSent": 1,
930 "localRtpPacketsDiscarded": 1,
931 "localRtpPacketsReceived": 1,
932 "localRtpPacketsSent": 1,
933 "mosCqe": 1,
934 "packetLossPercent": 1,
935 "packetsLost": 1,
936 "rFactor": 1,
937 "roundTripDelay": 1
938 },
939 "midCallRtcp": "somestring",
940 "phoneNumber": "somestring",
941 "vendorVnfNameFields": {
942 "vendorName": "somestring",
943 "vfModuleName": "somestring",
944 "vnfName": "somestring"
945 },
946 "voiceQualityFieldsVersion": 1
947 }
948 }
949 }
950
951Responses
952+++++++++
953
954**200**
955^^^^^^^
956
957VES Event Accepted.
958
959
960Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
961
962**Example:**
963
964.. code-block:: javascript
965
966 {
967 "code": 1,
968 "message": "somestring",
969 "type": "somestring"
970 }
971
972**400**
973^^^^^^^
974
975Bad request provided
976
977
978Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
979
980**Example:**
981
982.. code-block:: javascript
983
984 {
985 "code": 1,
986 "message": "somestring",
987 "type": "somestring"
988 }
989
990**401**
991^^^^^^^
992
993Unauthorized request
994
995
996Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
997
998**Example:**
999
1000.. code-block:: javascript
1001
1002 {
1003 "code": 1,
1004 "message": "somestring",
1005 "type": "somestring"
1006 }
1007
1008**503**
1009^^^^^^^
1010
1011Service Unavailable
1012
1013
1014Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1015
1016**Example:**
1017
1018.. code-block:: javascript
1019
1020 {
1021 "code": 1,
1022 "message": "somestring",
1023 "type": "somestring"
1024 }
1025
1026
1027
1028Security
1029++++++++
1030
1031.. csv-table::
1032 :header: "Security Schema", "Scopes"
1033 :widths: 15, 45
1034
1035 :ref:`basicAuth <securities_basicAuth>`, ""
1036
1037
1038POST ``/eventListener/v5/eventBatch``
1039-------------------------------------
1040
1041
1042
1043Description
1044+++++++++++
1045
1046.. raw:: html
1047
1048 uri for posting VES batch event objects
1049
1050
1051Request
1052+++++++
1053
1054
1055
1056.. _d_f598222d7a83ca9c3538556b263682d1:
1057
1058Body
1059^^^^
1060
1061.. csv-table::
1062 :delim: |
1063 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1064 :widths: 20, 10, 15, 15, 30, 25
1065
1066 event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
1067
1068.. code-block:: javascript
1069
1070 {
1071 "event": {
1072 "commonEventHeader": {
1073 "domain": "fault",
1074 "eventId": "somestring",
1075 "eventName": "somestring",
1076 "eventType": "somestring",
1077 "internalHeaderFields": {},
1078 "lastEpochMicrosec": 1,
1079 "nfNamingCode": "somestring",
1080 "nfcNamingCode": "somestring",
1081 "priority": "High",
1082 "reportingEntityId": "somestring",
1083 "reportingEntityName": "somestring",
1084 "sequence": 1,
1085 "sourceId": "somestring",
1086 "sourceName": "somestring",
1087 "startEpochMicrosec": 1,
1088 "version": 1
1089 },
1090 "faultFields": {
1091 "alarmAdditionalInformation": [
1092 {
1093 "name": "somestring",
1094 "value": "somestring"
1095 },
1096 {
1097 "name": "somestring",
1098 "value": "somestring"
1099 }
1100 ],
1101 "alarmCondition": "somestring",
1102 "alarmInterfaceA": "somestring",
1103 "eventCategory": "somestring",
1104 "eventSeverity": "CRITICAL",
1105 "eventSourceType": "somestring",
1106 "faultFieldsVersion": 1,
1107 "specificProblem": "somestring",
1108 "vfStatus": "Active"
1109 },
1110 "heartbeatFields": {
1111 "additionalFields": [
1112 {
1113 "name": "somestring",
1114 "value": "somestring"
1115 },
1116 {
1117 "name": "somestring",
1118 "value": "somestring"
1119 }
1120 ],
1121 "heartbeatFieldsVersion": 1,
1122 "heartbeatInterval": 1
1123 },
1124 "measurementsForVfScalingFields": {
1125 "additionalFields": [
1126 {
1127 "name": "somestring",
1128 "value": "somestring"
1129 },
1130 {
1131 "name": "somestring",
1132 "value": "somestring"
1133 }
1134 ],
1135 "additionalMeasurements": [
1136 {
1137 "arrayOfFields": [
1138 {
1139 "name": "somestring",
1140 "value": "somestring"
1141 },
1142 {
1143 "name": "somestring",
1144 "value": "somestring"
1145 }
1146 ],
1147 "name": "somestring"
1148 },
1149 {
1150 "arrayOfFields": [
1151 {
1152 "name": "somestring",
1153 "value": "somestring"
1154 },
1155 {
1156 "name": "somestring",
1157 "value": "somestring"
1158 }
1159 ],
1160 "name": "somestring"
1161 }
1162 ],
1163 "additionalObjects": [
1164 {
1165 "nfSubscribedObjectName": "somestring",
1166 "nfSubscriptionId": "somestring",
1167 "objectInstances": [
1168 {
1169 "objectInstance": {},
1170 "objectInstanceEpochMicrosec": 1,
1171 "objectKeys": [
1172 {
1173 "keyName": "somestring",
1174 "keyOrder": 1,
1175 "keyValue": "somestring"
1176 },
1177 {
1178 "keyName": "somestring",
1179 "keyOrder": 1,
1180 "keyValue": "somestring"
1181 }
1182 ]
1183 },
1184 {
1185 "objectInstance": {},
1186 "objectInstanceEpochMicrosec": 1,
1187 "objectKeys": [
1188 {
1189 "keyName": "somestring",
1190 "keyOrder": 1,
1191 "keyValue": "somestring"
1192 },
1193 {
1194 "keyName": "somestring",
1195 "keyOrder": 1,
1196 "keyValue": "somestring"
1197 }
1198 ]
1199 }
1200 ],
1201 "objectName": "somestring",
1202 "objectSchema": "somestring",
1203 "objectSchemaUrl": "somestring"
1204 },
1205 {
1206 "nfSubscribedObjectName": "somestring",
1207 "nfSubscriptionId": "somestring",
1208 "objectInstances": [
1209 {
1210 "objectInstance": {},
1211 "objectInstanceEpochMicrosec": 1,
1212 "objectKeys": [
1213 {
1214 "keyName": "somestring",
1215 "keyOrder": 1,
1216 "keyValue": "somestring"
1217 },
1218 {
1219 "keyName": "somestring",
1220 "keyOrder": 1,
1221 "keyValue": "somestring"
1222 }
1223 ]
1224 },
1225 {
1226 "objectInstance": {},
1227 "objectInstanceEpochMicrosec": 1,
1228 "objectKeys": [
1229 {
1230 "keyName": "somestring",
1231 "keyOrder": 1,
1232 "keyValue": "somestring"
1233 },
1234 {
1235 "keyName": "somestring",
1236 "keyOrder": 1,
1237 "keyValue": "somestring"
1238 }
1239 ]
1240 }
1241 ],
1242 "objectName": "somestring",
1243 "objectSchema": "somestring",
1244 "objectSchemaUrl": "somestring"
1245 }
1246 ],
1247 "codecUsageArray": [
1248 {
1249 "codecIdentifier": "somestring",
1250 "numberInUse": 1
1251 },
1252 {
1253 "codecIdentifier": "somestring",
1254 "numberInUse": 1
1255 }
1256 ],
1257 "concurrentSessions": 1,
1258 "configuredEntities": 1,
1259 "cpuUsageArray": [
1260 {
1261 "cpuIdentifier": "somestring",
1262 "cpuIdle": 1,
1263 "cpuUsageInterrupt": 1,
1264 "cpuUsageNice": 1,
1265 "cpuUsageSoftIrq": 1,
1266 "cpuUsageSteal": 1,
1267 "cpuUsageSystem": 1,
1268 "cpuUsageUser": 1,
1269 "cpuWait": 1,
1270 "percentUsage": 1
1271 },
1272 {
1273 "cpuIdentifier": "somestring",
1274 "cpuIdle": 1,
1275 "cpuUsageInterrupt": 1,
1276 "cpuUsageNice": 1,
1277 "cpuUsageSoftIrq": 1,
1278 "cpuUsageSteal": 1,
1279 "cpuUsageSystem": 1,
1280 "cpuUsageUser": 1,
1281 "cpuWait": 1,
1282 "percentUsage": 1
1283 }
1284 ],
1285 "diskUsageArray": [
1286 {
1287 "diskIdentifier": "somestring",
1288 "diskIoTimeAvg": 1,
1289 "diskIoTimeLast": 1,
1290 "diskIoTimeMax": 1,
1291 "diskIoTimeMin": 1,
1292 "diskMergedReadAvg": 1,
1293 "diskMergedReadLast": 1,
1294 "diskMergedReadMax": 1,
1295 "diskMergedReadMin": 1,
1296 "diskMergedWriteAvg": 1,
1297 "diskMergedWriteLast": 1,
1298 "diskMergedWriteMax": 1,
1299 "diskMergedWriteMin": 1,
1300 "diskOctetsReadAvg": 1,
1301 "diskOctetsReadLast": 1,
1302 "diskOctetsReadMax": 1,
1303 "diskOctetsReadMin": 1,
1304 "diskOctetsWriteAvg": 1,
1305 "diskOctetsWriteLast": 1,
1306 "diskOctetsWriteMax": 1,
1307 "diskOctetsWriteMin": 1,
1308 "diskOpsReadAvg": 1,
1309 "diskOpsReadLast": 1,
1310 "diskOpsReadMax": 1,
1311 "diskOpsReadMin": 1,
1312 "diskOpsWriteAvg": 1,
1313 "diskOpsWriteLast": 1,
1314 "diskOpsWriteMax": 1,
1315 "diskOpsWriteMin": 1,
1316 "diskPendingOperationsAvg": 1,
1317 "diskPendingOperationsLast": 1,
1318 "diskPendingOperationsMax": 1,
1319 "diskPendingOperationsMin": 1,
1320 "diskTimeReadAvg": 1,
1321 "diskTimeReadLast": 1,
1322 "diskTimeReadMax": 1,
1323 "diskTimeReadMin": 1,
1324 "diskTimeWriteAvg": 1,
1325 "diskTimeWriteLast": 1,
1326 "diskTimeWriteMax": 1,
1327 "diskTimeWriteMin": 1
1328 },
1329 {
1330 "diskIdentifier": "somestring",
1331 "diskIoTimeAvg": 1,
1332 "diskIoTimeLast": 1,
1333 "diskIoTimeMax": 1,
1334 "diskIoTimeMin": 1,
1335 "diskMergedReadAvg": 1,
1336 "diskMergedReadLast": 1,
1337 "diskMergedReadMax": 1,
1338 "diskMergedReadMin": 1,
1339 "diskMergedWriteAvg": 1,
1340 "diskMergedWriteLast": 1,
1341 "diskMergedWriteMax": 1,
1342 "diskMergedWriteMin": 1,
1343 "diskOctetsReadAvg": 1,
1344 "diskOctetsReadLast": 1,
1345 "diskOctetsReadMax": 1,
1346 "diskOctetsReadMin": 1,
1347 "diskOctetsWriteAvg": 1,
1348 "diskOctetsWriteLast": 1,
1349 "diskOctetsWriteMax": 1,
1350 "diskOctetsWriteMin": 1,
1351 "diskOpsReadAvg": 1,
1352 "diskOpsReadLast": 1,
1353 "diskOpsReadMax": 1,
1354 "diskOpsReadMin": 1,
1355 "diskOpsWriteAvg": 1,
1356 "diskOpsWriteLast": 1,
1357 "diskOpsWriteMax": 1,
1358 "diskOpsWriteMin": 1,
1359 "diskPendingOperationsAvg": 1,
1360 "diskPendingOperationsLast": 1,
1361 "diskPendingOperationsMax": 1,
1362 "diskPendingOperationsMin": 1,
1363 "diskTimeReadAvg": 1,
1364 "diskTimeReadLast": 1,
1365 "diskTimeReadMax": 1,
1366 "diskTimeReadMin": 1,
1367 "diskTimeWriteAvg": 1,
1368 "diskTimeWriteLast": 1,
1369 "diskTimeWriteMax": 1,
1370 "diskTimeWriteMin": 1
1371 }
1372 ],
1373 "featureUsageArray": [
1374 {
1375 "featureIdentifier": "somestring",
1376 "featureUtilization": 1
1377 },
1378 {
1379 "featureIdentifier": "somestring",
1380 "featureUtilization": 1
1381 }
1382 ],
1383 "filesystemUsageArray": [
1384 {
1385 "blockConfigured": 1,
1386 "blockIops": 1,
1387 "blockUsed": 1,
1388 "ephemeralConfigured": 1,
1389 "ephemeralIops": 1,
1390 "ephemeralUsed": 1,
1391 "filesystemName": "somestring"
1392 },
1393 {
1394 "blockConfigured": 1,
1395 "blockIops": 1,
1396 "blockUsed": 1,
1397 "ephemeralConfigured": 1,
1398 "ephemeralIops": 1,
1399 "ephemeralUsed": 1,
1400 "filesystemName": "somestring"
1401 }
1402 ],
1403 "latencyDistribution": [
1404 {
1405 "countsInTheBucket": 1,
1406 "highEndOfLatencyBucket": 1,
1407 "lowEndOfLatencyBucket": 1
1408 },
1409 {
1410 "countsInTheBucket": 1,
1411 "highEndOfLatencyBucket": 1,
1412 "lowEndOfLatencyBucket": 1
1413 }
1414 ],
1415 "meanRequestLatency": 1,
1416 "measurementInterval": 1,
1417 "measurementsForVfScalingVersion": 1,
1418 "memoryUsageArray": [
1419 {
1420 "memoryBuffered": 1,
1421 "memoryCached": 1,
1422 "memoryConfigured": 1,
1423 "memoryFree": 1,
1424 "memorySlabRecl": 1,
1425 "memorySlabUnrecl": 1,
1426 "memoryUsed": 1,
1427 "vmIdentifier": "somestring"
1428 },
1429 {
1430 "memoryBuffered": 1,
1431 "memoryCached": 1,
1432 "memoryConfigured": 1,
1433 "memoryFree": 1,
1434 "memorySlabRecl": 1,
1435 "memorySlabUnrecl": 1,
1436 "memoryUsed": 1,
1437 "vmIdentifier": "somestring"
1438 }
1439 ],
1440 "numberOfMediaPortsInUse": 1,
1441 "requestRate": 1,
1442 "vNicPerformanceArray": [
1443 {
1444 "receivedBroadcastPacketsAccumulated": 1,
1445 "receivedBroadcastPacketsDelta": 1,
1446 "receivedDiscardedPacketsAccumulated": 1,
1447 "receivedDiscardedPacketsDelta": 1,
1448 "receivedErrorPacketsAccumulated": 1,
1449 "receivedErrorPacketsDelta": 1,
1450 "receivedMulticastPacketsAccumulated": 1,
1451 "receivedMulticastPacketsDelta": 1,
1452 "receivedOctetsAccumulated": 1,
1453 "receivedOctetsDelta": 1,
1454 "receivedTotalPacketsAccumulated": 1,
1455 "receivedTotalPacketsDelta": 1,
1456 "receivedUnicastPacketsAccumulated": 1,
1457 "receivedUnicastPacketsDelta": 1,
1458 "transmittedBroadcastPacketsAccumulated": 1,
1459 "transmittedBroadcastPacketsDelta": 1,
1460 "transmittedDiscardedPacketsAccumulated": 1,
1461 "transmittedDiscardedPacketsDelta": 1,
1462 "transmittedErrorPacketsAccumulated": 1,
1463 "transmittedErrorPacketsDelta": 1,
1464 "transmittedMulticastPacketsAccumulated": 1,
1465 "transmittedMulticastPacketsDelta": 1,
1466 "transmittedOctetsAccumulated": 1,
1467 "transmittedOctetsDelta": 1,
1468 "transmittedTotalPacketsAccumulated": 1,
1469 "transmittedTotalPacketsDelta": 1,
1470 "transmittedUnicastPacketsAccumulated": 1,
1471 "transmittedUnicastPacketsDelta": 1,
1472 "vNicIdentifier": "somestring",
1473 "valuesAreSuspect": "true"
1474 },
1475 {
1476 "receivedBroadcastPacketsAccumulated": 1,
1477 "receivedBroadcastPacketsDelta": 1,
1478 "receivedDiscardedPacketsAccumulated": 1,
1479 "receivedDiscardedPacketsDelta": 1,
1480 "receivedErrorPacketsAccumulated": 1,
1481 "receivedErrorPacketsDelta": 1,
1482 "receivedMulticastPacketsAccumulated": 1,
1483 "receivedMulticastPacketsDelta": 1,
1484 "receivedOctetsAccumulated": 1,
1485 "receivedOctetsDelta": 1,
1486 "receivedTotalPacketsAccumulated": 1,
1487 "receivedTotalPacketsDelta": 1,
1488 "receivedUnicastPacketsAccumulated": 1,
1489 "receivedUnicastPacketsDelta": 1,
1490 "transmittedBroadcastPacketsAccumulated": 1,
1491 "transmittedBroadcastPacketsDelta": 1,
1492 "transmittedDiscardedPacketsAccumulated": 1,
1493 "transmittedDiscardedPacketsDelta": 1,
1494 "transmittedErrorPacketsAccumulated": 1,
1495 "transmittedErrorPacketsDelta": 1,
1496 "transmittedMulticastPacketsAccumulated": 1,
1497 "transmittedMulticastPacketsDelta": 1,
1498 "transmittedOctetsAccumulated": 1,
1499 "transmittedOctetsDelta": 1,
1500 "transmittedTotalPacketsAccumulated": 1,
1501 "transmittedTotalPacketsDelta": 1,
1502 "transmittedUnicastPacketsAccumulated": 1,
1503 "transmittedUnicastPacketsDelta": 1,
1504 "vNicIdentifier": "somestring",
1505 "valuesAreSuspect": "true"
1506 }
1507 ],
1508 "vnfcScalingMetric": 1
1509 },
1510 "mobileFlowFields": {
1511 "additionalFields": [
1512 {
1513 "name": "somestring",
1514 "value": "somestring"
1515 },
1516 {
1517 "name": "somestring",
1518 "value": "somestring"
1519 }
1520 ],
1521 "appProtocolType": "somestring",
1522 "appProtocolVersion": "somestring",
1523 "applicationType": "somestring",
1524 "cid": "somestring",
1525 "connectionType": "somestring",
1526 "ecgi": "somestring",
1527 "flowDirection": "somestring",
1528 "gtpPerFlowMetrics": {
1529 "avgBitErrorRate": 1,
1530 "avgPacketDelayVariation": 1,
1531 "avgPacketLatency": 1,
1532 "avgReceiveThroughput": 1,
1533 "avgTransmitThroughput": 1,
1534 "durConnectionFailedStatus": 1,
1535 "durTunnelFailedStatus": 1,
1536 "flowActivatedBy": "somestring",
1537 "flowActivationEpoch": 1,
1538 "flowActivationMicrosec": 1,
1539 "flowActivationTime": "somestring",
1540 "flowDeactivatedBy": "somestring",
1541 "flowDeactivationEpoch": 1,
1542 "flowDeactivationMicrosec": 1,
1543 "flowDeactivationTime": "somestring",
1544 "flowStatus": "somestring",
1545 "gtpConnectionStatus": "somestring",
1546 "gtpTunnelStatus": "somestring",
1547 "ipTosCountList": [
1548 [
1549 1,
1550 1
1551 ],
1552 [
1553 1,
1554 1
1555 ]
1556 ],
1557 "ipTosList": [
1558 "somestring",
1559 "somestring"
1560 ],
1561 "largePacketRtt": 1,
1562 "largePacketThreshold": 1,
1563 "maxPacketDelayVariation": 1,
1564 "maxReceiveBitRate": 1,
1565 "maxTransmitBitRate": 1,
1566 "mobileQciCosCountList": [
1567 [
1568 1,
1569 1
1570 ],
1571 [
1572 1,
1573 1
1574 ]
1575 ],
1576 "mobileQciCosList": [
1577 "somestring",
1578 "somestring"
1579 ],
1580 "numActivationFailures": 1,
1581 "numBitErrors": 1,
1582 "numBytesReceived": 1,
1583 "numBytesTransmitted": 1,
1584 "numDroppedPackets": 1,
1585 "numGtpEchoFailures": 1,
1586 "numGtpTunnelErrors": 1,
1587 "numHttpErrors": 1,
1588 "numL7BytesReceived": 1,
1589 "numL7BytesTransmitted": 1,
1590 "numLostPackets": 1,
1591 "numOutOfOrderPackets": 1,
1592 "numPacketErrors": 1,
1593 "numPacketsReceivedExclRetrans": 1,
1594 "numPacketsReceivedInclRetrans": 1,
1595 "numPacketsTransmittedInclRetrans": 1,
1596 "numRetries": 1,
1597 "numTimeouts": 1,
1598 "numTunneledL7BytesReceived": 1,
1599 "roundTripTime": 1,
1600 "tcpFlagCountList": [
1601 [
1602 1,
1603 1
1604 ],
1605 [
1606 1,
1607 1
1608 ]
1609 ],
1610 "tcpFlagList": [
1611 "somestring",
1612 "somestring"
1613 ],
1614 "timeToFirstByte": 1
1615 },
1616 "gtpProtocolType": "somestring",
1617 "gtpVersion": "somestring",
1618 "httpHeader": "somestring",
1619 "imei": "somestring",
1620 "imsi": "somestring",
1621 "ipProtocolType": "somestring",
1622 "ipVersion": "somestring",
1623 "lac": "somestring",
1624 "mcc": "somestring",
1625 "mnc": "somestring",
1626 "mobileFlowFieldsVersion": 1,
1627 "msisdn": "somestring",
1628 "otherEndpointIpAddress": "somestring",
1629 "otherEndpointPort": 1,
1630 "otherFunctionalRole": "somestring",
1631 "rac": "somestring",
1632 "radioAccessTechnology": "somestring",
1633 "reportingEndpointIpAddr": "somestring",
1634 "reportingEndpointPort": 1,
1635 "sac": "somestring",
1636 "samplingAlgorithm": 1,
1637 "tac": "somestring",
1638 "tunnelId": "somestring",
1639 "vlanId": "somestring"
1640 },
1641 "otherFields": {
1642 "hashOfNameValuePairArrays": [
1643 {
1644 "arrayOfFields": [
1645 {
1646 "name": "somestring",
1647 "value": "somestring"
1648 },
1649 {
1650 "name": "somestring",
1651 "value": "somestring"
1652 }
1653 ],
1654 "name": "somestring"
1655 },
1656 {
1657 "arrayOfFields": [
1658 {
1659 "name": "somestring",
1660 "value": "somestring"
1661 },
1662 {
1663 "name": "somestring",
1664 "value": "somestring"
1665 }
1666 ],
1667 "name": "somestring"
1668 }
1669 ],
1670 "jsonObjects": [
1671 {
1672 "nfSubscribedObjectName": "somestring",
1673 "nfSubscriptionId": "somestring",
1674 "objectInstances": [
1675 {
1676 "objectInstance": {},
1677 "objectInstanceEpochMicrosec": 1,
1678 "objectKeys": [
1679 {
1680 "keyName": "somestring",
1681 "keyOrder": 1,
1682 "keyValue": "somestring"
1683 },
1684 {
1685 "keyName": "somestring",
1686 "keyOrder": 1,
1687 "keyValue": "somestring"
1688 }
1689 ]
1690 },
1691 {
1692 "objectInstance": {},
1693 "objectInstanceEpochMicrosec": 1,
1694 "objectKeys": [
1695 {
1696 "keyName": "somestring",
1697 "keyOrder": 1,
1698 "keyValue": "somestring"
1699 },
1700 {
1701 "keyName": "somestring",
1702 "keyOrder": 1,
1703 "keyValue": "somestring"
1704 }
1705 ]
1706 }
1707 ],
1708 "objectName": "somestring",
1709 "objectSchema": "somestring",
1710 "objectSchemaUrl": "somestring"
1711 },
1712 {
1713 "nfSubscribedObjectName": "somestring",
1714 "nfSubscriptionId": "somestring",
1715 "objectInstances": [
1716 {
1717 "objectInstance": {},
1718 "objectInstanceEpochMicrosec": 1,
1719 "objectKeys": [
1720 {
1721 "keyName": "somestring",
1722 "keyOrder": 1,
1723 "keyValue": "somestring"
1724 },
1725 {
1726 "keyName": "somestring",
1727 "keyOrder": 1,
1728 "keyValue": "somestring"
1729 }
1730 ]
1731 },
1732 {
1733 "objectInstance": {},
1734 "objectInstanceEpochMicrosec": 1,
1735 "objectKeys": [
1736 {
1737 "keyName": "somestring",
1738 "keyOrder": 1,
1739 "keyValue": "somestring"
1740 },
1741 {
1742 "keyName": "somestring",
1743 "keyOrder": 1,
1744 "keyValue": "somestring"
1745 }
1746 ]
1747 }
1748 ],
1749 "objectName": "somestring",
1750 "objectSchema": "somestring",
1751 "objectSchemaUrl": "somestring"
1752 }
1753 ],
1754 "nameValuePairs": [
1755 {
1756 "name": "somestring",
1757 "value": "somestring"
1758 },
1759 {
1760 "name": "somestring",
1761 "value": "somestring"
1762 }
1763 ],
1764 "otherFieldsVersion": 1
1765 },
1766 "sipSignalingFields": {
1767 "additionalInformation": [
1768 {
1769 "name": "somestring",
1770 "value": "somestring"
1771 },
1772 {
1773 "name": "somestring",
1774 "value": "somestring"
1775 }
1776 ],
1777 "compressedSip": "somestring",
1778 "correlator": "somestring",
1779 "localIpAddress": "somestring",
1780 "localPort": "somestring",
1781 "remoteIpAddress": "somestring",
1782 "remotePort": "somestring",
1783 "sipSignalingFieldsVersion": 1,
1784 "summarySip": "somestring",
1785 "vendorVnfNameFields": {
1786 "vendorName": "somestring",
1787 "vfModuleName": "somestring",
1788 "vnfName": "somestring"
1789 }
1790 },
1791 "stateChangeFields": {
1792 "additionalFields": [
1793 {
1794 "name": "somestring",
1795 "value": "somestring"
1796 },
1797 {
1798 "name": "somestring",
1799 "value": "somestring"
1800 }
1801 ],
1802 "newState": "inService",
1803 "oldState": "inService",
1804 "stateChangeFieldsVersion": 1,
1805 "stateInterface": "somestring"
1806 },
1807 "syslogFields": {
1808 "additionalFields": "somestring",
1809 "eventSourceHost": "somestring",
1810 "eventSourceType": "somestring",
1811 "syslogFacility": 1,
1812 "syslogFieldsVersion": 1,
1813 "syslogMsg": "somestring",
1814 "syslogPri": 1,
1815 "syslogProc": "somestring",
1816 "syslogProcId": 1,
1817 "syslogSData": "somestring",
1818 "syslogSdId": "somestring",
1819 "syslogSev": "Alert",
1820 "syslogTag": "somestring",
1821 "syslogVer": 1
1822 },
1823 "thresholdCrossingAlertFields": {
1824 "additionalFields": [
1825 {
1826 "name": "somestring",
1827 "value": "somestring"
1828 },
1829 {
1830 "name": "somestring",
1831 "value": "somestring"
1832 }
1833 ],
1834 "additionalParameters": [
1835 {
1836 "criticality": "CRIT",
1837 "name": "somestring",
1838 "thresholdCrossed": "somestring",
1839 "value": "somestring"
1840 },
1841 {
1842 "criticality": "CRIT",
1843 "name": "somestring",
1844 "thresholdCrossed": "somestring",
1845 "value": "somestring"
1846 }
1847 ],
1848 "alertAction": "CLEAR",
1849 "alertDescription": "somestring",
1850 "alertType": "CARD-ANOMALY",
1851 "alertValue": "somestring",
1852 "associatedAlertIdList": [
1853 "somestring",
1854 "somestring"
1855 ],
1856 "collectionTimestamp": "somestring",
1857 "dataCollector": "somestring",
1858 "elementType": "somestring",
1859 "eventSeverity": "CRITICAL",
1860 "eventStartTimestamp": "somestring",
1861 "interfaceName": "somestring",
1862 "networkService": "somestring",
1863 "possibleRootCause": "somestring",
1864 "thresholdCrossingFieldsVersion": 1
1865 },
1866 "voiceQualityFields": {
1867 "additionalInformation": [
1868 {
1869 "name": "somestring",
1870 "value": "somestring"
1871 },
1872 {
1873 "name": "somestring",
1874 "value": "somestring"
1875 }
1876 ],
1877 "calleeSideCodec": "somestring",
1878 "callerSideCodec": "somestring",
1879 "correlator": "somestring",
1880 "endOfCallVqmSummaries": {
1881 "adjacencyName": "somestring",
1882 "endpointDescription": "Caller",
1883 "endpointJitter": 1,
1884 "endpointRtpOctetsDiscarded": 1,
1885 "endpointRtpOctetsReceived": 1,
1886 "endpointRtpOctetsSent": 1,
1887 "endpointRtpPacketsDiscarded": 1,
1888 "endpointRtpPacketsReceived": 1,
1889 "endpointRtpPacketsSent": 1,
1890 "localJitter": 1,
1891 "localRtpOctetsDiscarded": 1,
1892 "localRtpOctetsReceived": 1,
1893 "localRtpOctetsSent": 1,
1894 "localRtpPacketsDiscarded": 1,
1895 "localRtpPacketsReceived": 1,
1896 "localRtpPacketsSent": 1,
1897 "mosCqe": 1,
1898 "packetLossPercent": 1,
1899 "packetsLost": 1,
1900 "rFactor": 1,
1901 "roundTripDelay": 1
1902 },
1903 "midCallRtcp": "somestring",
1904 "phoneNumber": "somestring",
1905 "vendorVnfNameFields": {
1906 "vendorName": "somestring",
1907 "vfModuleName": "somestring",
1908 "vnfName": "somestring"
1909 },
1910 "voiceQualityFieldsVersion": 1
1911 }
1912 }
1913 }
1914
1915Responses
1916+++++++++
1917
1918**200**
1919^^^^^^^
1920
1921VES Event Accepted.
1922
1923
1924Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1925
1926**Example:**
1927
1928.. code-block:: javascript
1929
1930 {
1931 "code": 1,
1932 "message": "somestring",
1933 "type": "somestring"
1934 }
1935
1936**400**
1937^^^^^^^
1938
1939Bad request provided
1940
1941
1942Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1943
1944**Example:**
1945
1946.. code-block:: javascript
1947
1948 {
1949 "code": 1,
1950 "message": "somestring",
1951 "type": "somestring"
1952 }
1953
1954**401**
1955^^^^^^^
1956
1957Unauthorized request
1958
1959
1960Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1961
1962**Example:**
1963
1964.. code-block:: javascript
1965
1966 {
1967 "code": 1,
1968 "message": "somestring",
1969 "type": "somestring"
1970 }
1971
1972**503**
1973^^^^^^^
1974
1975Service Unavailable
1976
1977
1978Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1979
1980**Example:**
1981
1982.. code-block:: javascript
1983
1984 {
1985 "code": 1,
1986 "message": "somestring",
1987 "type": "somestring"
1988 }
1989
1990
1991
1992Security
1993++++++++
1994
1995.. csv-table::
1996 :header: "Security Schema", "Scopes"
1997 :widths: 15, 45
1998
1999 :ref:`basicAuth <securities_basicAuth>`, ""
2000
2001Data Structures
2002~~~~~~~~~~~~~~~
2003
2004.. _d_8a94f348f7df00259702f8d9b7d2ea84:
2005
2006ApiResponseMessage Model Structure
2007----------------------------------
2008
2009.. csv-table::
2010 :delim: |
2011 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2012 :widths: 20, 10, 15, 15, 30, 25
2013
2014 code | No | integer | int32 | |
2015 message | No | string | | |
2016 type | No | string | | |
2017
2018.. _d_f598222d7a83ca9c3538556b263682d1:
2019
2020VES5Request Model Structure
2021---------------------------
2022
2023.. csv-table::
2024 :delim: |
2025 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2026 :widths: 20, 10, 15, 15, 30, 25
2027
2028 event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
2029
2030.. _d_df249c51a416f54e5609f2ffffe059c0:
2031
2032codecsInUse Model Structure
2033---------------------------
2034
2035number of times an identified codec was used over the measurementInterval
2036
2037.. csv-table::
2038 :delim: |
2039 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2040 :widths: 20, 10, 15, 15, 30, 25
2041
2042 codecIdentifier | Yes | string | | |
2043 numberInUse | Yes | integer | | |
2044
2045.. _d_a68e1b21fdcef792db73f711201c56ad:
2046
2047command Model Structure
2048-----------------------
2049
2050command from an event collector toward an event source
2051
2052.. csv-table::
2053 :delim: |
2054 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2055 :widths: 20, 10, 15, 15, 30, 25
2056
2057 commandType | Yes | string | | {'enum': ['heartbeatIntervalChange', 'measurementIntervalChange', 'provideThrottlingState', 'throttlingSpecification']} |
2058 eventDomainThrottleSpecification | No | :ref:`eventDomainThrottleSpecification <d_4089a4a9ee684770c6f37a588a577589>` | | |
2059 heartbeatInterval | No | integer | | |
2060 measurementInterval | No | integer | | |
2061
2062.. _d_2dc9a27be1410f60241c5f63c636bb7e:
2063
2064commonEventHeader Model Structure
2065---------------------------------
2066
2067fields common to all events
2068
2069.. csv-table::
2070 :delim: |
2071 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2072 :widths: 20, 10, 15, 15, 30, 25
2073
2074 domain | Yes | string | | {'enum': ['fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality']} | the eventing domain associated with the event
2075 eventId | Yes | string | | | event key that is unique to the event source
2076 eventName | Yes | string | | | unique event name
2077 eventType | No | string | | | for example - applicationVnf, guestOS, hostOS, platform
2078 internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` | | |
2079 lastEpochMicrosec | Yes | number | | | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds
2080 nfNamingCode | No | string | | | 4 character network function type, aligned with vnf naming standards
2081 nfcNamingCode | No | string | | | 3 character network function component type, aligned with vfc naming standards
2082 priority | Yes | string | | {'enum': ['High', 'Medium', 'Normal', 'Low']} | processing priority
2083 reportingEntityId | No | string | | | UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process
2084 reportingEntityName | Yes | string | | | name of the entity reporting the event, for example, an EMS name; may be the same as sourceName
2085 sequence | Yes | integer | | | ordering of events communicated by an event source instance or 0 if not needed
2086 sourceId | No | string | | | UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process
2087 sourceName | Yes | string | | | name of the entity experiencing the event issue
2088 startEpochMicrosec | Yes | number | | | the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds
2089 version | Yes | number | | | version of the event header
2090
2091.. _d_6e043350cba5faafe21de49c2f6fd745:
2092
2093counter Model Structure
2094-----------------------
2095
2096performance counter
2097
2098.. csv-table::
2099 :delim: |
2100 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2101 :widths: 20, 10, 15, 15, 30, 25
2102
2103 criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} |
2104 name | Yes | string | | |
2105 thresholdCrossed | Yes | string | | |
2106 value | Yes | string | | |
2107
2108.. _d_6f081937f31c09078c8acf9212d6c449:
2109
2110cpuUsage Model Structure
2111------------------------
2112
2113usage of an identified CPU
2114
2115.. csv-table::
2116 :delim: |
2117 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2118 :widths: 20, 10, 15, 15, 30, 25
2119
2120 cpuIdentifier | Yes | string | | | cpu identifer
2121 cpuIdle | No | number | | | percentage of CPU time spent in the idle task
2122 cpuUsageInterrupt | No | number | | | percentage of time spent servicing interrupts
2123 cpuUsageNice | No | number | | | percentage of time spent running user space processes that have been niced
2124 cpuUsageSoftIrq | No | number | | | percentage of time spent handling soft irq interrupts
2125 cpuUsageSteal | No | number | | | percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing
2126 cpuUsageSystem | No | number | | | percentage of time spent on system tasks running the kernel
2127 cpuUsageUser | No | number | | | percentage of time spent running un-niced user space processes
2128 cpuWait | No | number | | | percentage of CPU time spent waiting for I/O operations to complete
2129 percentUsage | Yes | number | | | aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running
2130
2131.. _d_bb7a69764c21219953df76826934938e:
2132
2133diskUsage Model Structure
2134-------------------------
2135
2136usage of an identified disk
2137
2138.. csv-table::
2139 :delim: |
2140 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2141 :widths: 20, 10, 15, 15, 30, 25
2142
2143 diskIdentifier | Yes | string | | | disk identifier
2144 diskIoTimeAvg | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval
2145 diskIoTimeLast | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval
2146 diskIoTimeMax | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval
2147 diskIoTimeMin | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval
2148 diskMergedReadAvg | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval
2149 diskMergedReadLast | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval
2150 diskMergedReadMax | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval
2151 diskMergedReadMin | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval
2152 diskMergedWriteAvg | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval
2153 diskMergedWriteLast | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval
2154 diskMergedWriteMax | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval
2155 diskMergedWriteMin | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval
2156 diskOctetsReadAvg | No | number | | | number of octets per second read from a disk or partition; provide the average measurement within the measurement interval
2157 diskOctetsReadLast | No | number | | | number of octets per second read from a disk or partition; provide the last measurement within the measurement interval
2158 diskOctetsReadMax | No | number | | | number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval
2159 diskOctetsReadMin | No | number | | | number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval
2160 diskOctetsWriteAvg | No | number | | | number of octets per second written to a disk or partition; provide the average measurement within the measurement interval
2161 diskOctetsWriteLast | No | number | | | number of octets per second written to a disk or partition; provide the last measurement within the measurement interval
2162 diskOctetsWriteMax | No | number | | | number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval
2163 diskOctetsWriteMin | No | number | | | number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval
2164 diskOpsReadAvg | No | number | | | number of read operations per second issued to the disk; provide the average measurement within the measurement interval
2165 diskOpsReadLast | No | number | | | number of read operations per second issued to the disk; provide the last measurement within the measurement interval
2166 diskOpsReadMax | No | number | | | number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval
2167 diskOpsReadMin | No | number | | | number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval
2168 diskOpsWriteAvg | No | number | | | number of write operations per second issued to the disk; provide the average measurement within the measurement interval
2169 diskOpsWriteLast | No | number | | | number of write operations per second issued to the disk; provide the last measurement within the measurement interval
2170 diskOpsWriteMax | No | number | | | number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval
2171 diskOpsWriteMin | No | number | | | number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval
2172 diskPendingOperationsAvg | No | number | | | queue size of pending I/O operations per second; provide the average measurement within the measurement interval
2173 diskPendingOperationsLast | No | number | | | queue size of pending I/O operations per second; provide the last measurement within the measurement interval
2174 diskPendingOperationsMax | No | number | | | queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval
2175 diskPendingOperationsMin | No | number | | | queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval
2176 diskTimeReadAvg | No | number | | | milliseconds a read operation took to complete; provide the average measurement within the measurement interval
2177 diskTimeReadLast | No | number | | | milliseconds a read operation took to complete; provide the last measurement within the measurement interval
2178 diskTimeReadMax | No | number | | | milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval
2179 diskTimeReadMin | No | number | | | milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval
2180 diskTimeWriteAvg | No | number | | | milliseconds a write operation took to complete; provide the average measurement within the measurement interval
2181 diskTimeWriteLast | No | number | | | milliseconds a write operation took to complete; provide the last measurement within the measurement interval
2182 diskTimeWriteMax | No | number | | | milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval
2183 diskTimeWriteMin | No | number | | | milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval
2184
2185.. _d_c911a0a8abdb511d7cd6590f383d817b:
2186
2187endOfCallVqmSummaries Model Structure
2188-------------------------------------
2189
2190provides end of call voice quality metrics
2191
2192.. csv-table::
2193 :delim: |
2194 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2195 :widths: 20, 10, 15, 15, 30, 25
2196
2197 adjacencyName | Yes | string | | | adjacency name
2198 endpointDescription | Yes | string | | {'enum': ['Caller', 'Callee']} | Either Caller or Callee
2199 endpointJitter | No | number | | |
2200 endpointRtpOctetsDiscarded | No | number | | |
2201 endpointRtpOctetsReceived | No | number | | |
2202 endpointRtpOctetsSent | No | number | | |
2203 endpointRtpPacketsDiscarded | No | number | | |
2204 endpointRtpPacketsReceived | No | number | | |
2205 endpointRtpPacketsSent | No | number | | |
2206 localJitter | No | number | | |
2207 localRtpOctetsDiscarded | No | number | | |
2208 localRtpOctetsReceived | No | number | | |
2209 localRtpOctetsSent | No | number | | |
2210 localRtpPacketsDiscarded | No | number | | |
2211 localRtpPacketsReceived | No | number | | |
2212 localRtpPacketsSent | No | number | | |
2213 mosCqe | No | number | | | 1-5 1dp
2214 packetLossPercent | No | number | | | Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp)
2215 packetsLost | No | number | | |
2216 rFactor | No | number | | | 0-100
2217 roundTripDelay | No | number | | | millisecs
2218
2219.. _d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb:
2220
2221event Model Structure
2222---------------------
2223
2224the root level of the common event format
2225
2226.. csv-table::
2227 :delim: |
2228 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2229 :widths: 20, 10, 15, 15, 30, 25
2230
2231 commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` | | |
2232 faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` | | |
2233 heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` | | |
2234 measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` | | |
2235 mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` | | |
2236 otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` | | |
2237 sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` | | |
2238 stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` | | |
2239 syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` | | |
2240 thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` | | |
2241 voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` | | |
2242
2243.. _d_4089a4a9ee684770c6f37a588a577589:
2244
2245eventDomainThrottleSpecification Model Structure
2246------------------------------------------------
2247
2248specification of what information to suppress within an event domain
2249
2250.. csv-table::
2251 :delim: |
2252 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2253 :widths: 20, 10, 15, 15, 30, 25
2254
2255 eventDomain | Yes | string | | | Event domain enum from the commonEventHeader domain field
2256 suppressedFieldNames | No | array of string | | | List of optional field names in the event block that should not be sent to the Event Listener
2257 suppressedNvPairsList | No | array of :ref:`suppressedNvPairs <d_52877eda2d273b282063857f97fa7ff4>` | | | Optional list of specific NvPairsNames to suppress within a given Name-Value Field
2258
2259.. _d_e7aa5254472f7823fdd6d5a090bfd0a4:
2260
2261faultFields Model Structure
2262---------------------------
2263
2264fields specific to fault events
2265
2266.. csv-table::
2267 :delim: |
2268 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2269 :widths: 20, 10, 15, 15, 30, 25
2270
2271 alarmAdditionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional alarm information
2272 alarmCondition | Yes | string | | | alarm condition reported by the device
2273 alarmInterfaceA | No | string | | | card, port, channel or interface name of the device generating the alarm
2274 eventCategory | No | string | | | Event category, for example: license, link, routing, security, signaling
2275 eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity
2276 eventSourceType | Yes | string | | | type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction
2277 faultFieldsVersion | Yes | number | | | version of the faultFields block
2278 specificProblem | Yes | string | | | short description of the alarm or problem
2279 vfStatus | Yes | string | | {'enum': ['Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting termination']} | virtual function status enumeration
2280
2281.. _d_76d7f35861442236cee9f716ea1e1540:
2282
2283featuresInUse Model Structure
2284-----------------------------
2285
2286number of times an identified feature was used over the measurementInterval
2287
2288.. csv-table::
2289 :delim: |
2290 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2291 :widths: 20, 10, 15, 15, 30, 25
2292
2293 featureIdentifier | Yes | string | | |
2294 featureUtilization | Yes | integer | | |
2295
2296.. _d_a9799335edbbc52c7f0c5191f7bd09ee:
2297
2298field Model Structure
2299---------------------
2300
2301name value pair
2302
2303.. csv-table::
2304 :delim: |
2305 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2306 :widths: 20, 10, 15, 15, 30, 25
2307
2308 name | Yes | string | | |
2309 value | Yes | string | | |
2310
2311.. _d_18e1fa5fd6774deefce826b075f8b6e7:
2312
2313filesystemUsage Model Structure
2314-------------------------------
2315
2316disk usage of an identified virtual machine in gigabytes and/or gigabytes per second
2317
2318.. csv-table::
2319 :delim: |
2320 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2321 :widths: 20, 10, 15, 15, 30, 25
2322
2323 blockConfigured | Yes | number | | |
2324 blockIops | Yes | number | | |
2325 blockUsed | Yes | number | | |
2326 ephemeralConfigured | Yes | number | | |
2327 ephemeralIops | Yes | number | | |
2328 ephemeralUsed | Yes | number | | |
2329 filesystemName | Yes | string | | |
2330
2331.. _d_bb1527d221e848e0896c78552979238b:
2332
2333gtpPerFlowMetrics Model Structure
2334---------------------------------
2335
2336Mobility GTP Protocol per flow metrics
2337
2338.. csv-table::
2339 :delim: |
2340 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2341 :widths: 20, 10, 15, 15, 30, 25
2342
2343 avgBitErrorRate | Yes | number | | | average bit error rate
2344 avgPacketDelayVariation | Yes | number | | | Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets
2345 avgPacketLatency | Yes | number | | | average delivery latency
2346 avgReceiveThroughput | Yes | number | | | average receive throughput
2347 avgTransmitThroughput | Yes | number | | | average transmit throughput
2348 durConnectionFailedStatus | No | number | | | duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval
2349 durTunnelFailedStatus | No | number | | | Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval
2350 flowActivatedBy | No | string | | | Endpoint activating the flow
2351 flowActivationEpoch | Yes | number | | | Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available
2352 flowActivationMicrosec | Yes | number | | | Integer microseconds for the start of the flow connection
2353 flowActivationTime | No | string | | | time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800
2354 flowDeactivatedBy | No | string | | | Endpoint deactivating the flow
2355 flowDeactivationEpoch | Yes | number | | | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time
2356 flowDeactivationMicrosec | Yes | number | | | Integer microseconds for the start of the flow connection
2357 flowDeactivationTime | Yes | string | | | Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800
2358 flowStatus | Yes | string | | | connection status at reporting time as a working / inactive / failed indicator value
2359 gtpConnectionStatus | No | string | | | Current connection state at reporting time
2360 gtpTunnelStatus | No | string | | | Current tunnel state at reporting time
2361 ipTosCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow
2362 ipTosList | No | array of string | | | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255'
2363 largePacketRtt | No | number | | | large packet round trip time
2364 largePacketThreshold | No | number | | | large packet threshold being applied
2365 maxPacketDelayVariation | Yes | number | | | Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets
2366 maxReceiveBitRate | No | number | | | maximum receive bit rate
2367 maxTransmitBitRate | No | number | | | maximum transmit bit rate
2368 mobileQciCosCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow
2369 mobileQciCosList | No | array of string | | | Array of unique LTE QCI or UMTS class-of-service values observed in the flow
2370 numActivationFailures | Yes | number | | | Number of failed activation requests, as observed by the reporting node
2371 numBitErrors | Yes | number | | | number of errored bits
2372 numBytesReceived | Yes | number | | | number of bytes received, including retransmissions
2373 numBytesTransmitted | Yes | number | | | number of bytes transmitted, including retransmissions
2374 numDroppedPackets | Yes | number | | | number of received packets dropped due to errors per virtual interface
2375 numGtpEchoFailures | No | number | | | Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2
2376 numGtpTunnelErrors | No | number | | | Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1
2377 numHttpErrors | No | number | | | Http error count
2378 numL7BytesReceived | Yes | number | | | number of tunneled layer 7 bytes received, including retransmissions
2379 numL7BytesTransmitted | Yes | number | | | number of tunneled layer 7 bytes transmitted, excluding retransmissions
2380 numLostPackets | Yes | number | | | number of lost packets
2381 numOutOfOrderPackets | Yes | number | | | number of out-of-order packets
2382 numPacketErrors | Yes | number | | | number of errored packets
2383 numPacketsReceivedExclRetrans | Yes | number | | | number of packets received, excluding retransmission
2384 numPacketsReceivedInclRetrans | Yes | number | | | number of packets received, including retransmission
2385 numPacketsTransmittedInclRetrans | Yes | number | | | number of packets transmitted, including retransmissions
2386 numRetries | Yes | number | | | number of packet retries
2387 numTimeouts | Yes | number | | | number of packet timeouts
2388 numTunneledL7BytesReceived | Yes | number | | | number of tunneled layer 7 bytes received, excluding retransmissions
2389 roundTripTime | Yes | number | | | round trip time
2390 tcpFlagCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow
2391 tcpFlagList | No | array of string | | | Array of unique TCP Flags observed in the flow
2392 timeToFirstByte | Yes | number | | | Time in milliseconds between the connection activation and first byte received
2393
2394.. _d_6ea626e11ce7887cddd39c36ff4f0926:
2395
2396heartbeatFields Model Structure
2397-------------------------------
2398
2399optional field block for fields specific to heartbeat events
2400
2401.. csv-table::
2402 :delim: |
2403 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2404 :widths: 20, 10, 15, 15, 30, 25
2405
2406 additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional heartbeat fields if needed
2407 heartbeatFieldsVersion | Yes | number | | | version of the heartbeatFields block
2408 heartbeatInterval | Yes | integer | | | current heartbeat interval in seconds
2409
2410.. _d_2873d30f54c59ef635c1fc0cbbaa89f1:
2411
2412internalHeaderFields Model Structure
2413------------------------------------
2414
2415enrichment fields for internal VES Event Listener service use only, not supplied by event sources
2416
2417
2418
2419.. _d_d8868aee802ae8e2b1e7ea1c4ecc1f54:
2420
2421jsonObject Model Structure
2422--------------------------
2423
2424json object schema, name and other meta-information along with one or more object instances
2425
2426.. csv-table::
2427 :delim: |
2428 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2429 :widths: 20, 10, 15, 15, 30, 25
2430
2431 nfSubscribedObjectName | No | string | | | name of the object associated with the nfSubscriptonId
2432 nfSubscriptionId | No | string | | | identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject
2433 objectInstances | Yes | array of :ref:`jsonObjectInstance <d_7bccbee07bd3044bd0b929cb6b567c03>` | | | one or more instances of the jsonObject
2434 objectName | Yes | string | | | name of the JSON Object
2435 objectSchema | No | string | | | json schema for the object
2436 objectSchemaUrl | No | string | | | Url to the json schema for the object
2437
2438.. _d_7bccbee07bd3044bd0b929cb6b567c03:
2439
2440jsonObjectInstance Model Structure
2441----------------------------------
2442
2443meta-information about an instance of a jsonObject along with the actual object instance
2444
2445.. csv-table::
2446 :delim: |
2447 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2448 :widths: 20, 10, 15, 15, 30, 25
2449
2450 objectInstance | Yes | :ref:`objectInstance <i_c0493c6178d712e91e73c63587e27067>` | | | an instance conforming to the jsonObject schema
2451 objectInstanceEpochMicrosec | No | number | | | the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds
2452 objectKeys | No | array of :ref:`key <d_a217491e9c44487ec7bbd9ce3ac9dddb>` | | | an ordered set of keys that identifies this particular instance of jsonObject
2453
2454.. _i_c0493c6178d712e91e73c63587e27067:
2455
2456**Objectinstance schema:**
2457
2458
2459an instance conforming to the jsonObject schema
2460
2461
2462
2463.. _d_a217491e9c44487ec7bbd9ce3ac9dddb:
2464
2465key Model Structure
2466-------------------
2467
2468tuple which provides the name of a key along with its value and relative order
2469
2470.. csv-table::
2471 :delim: |
2472 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2473 :widths: 20, 10, 15, 15, 30, 25
2474
2475 keyName | Yes | string | | | name of the key
2476 keyOrder | No | integer | | | relative sequence or order of the key with respect to other keys
2477 keyValue | No | string | | | value of the key
2478
2479.. _d_dc21244021b6cb0e0af16166e4600d99:
2480
2481latencyBucketMeasure Model Structure
2482------------------------------------
2483
2484number of counts falling within a defined latency bucket
2485
2486.. csv-table::
2487 :delim: |
2488 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2489 :widths: 20, 10, 15, 15, 30, 25
2490
2491 countsInTheBucket | Yes | number | | |
2492 highEndOfLatencyBucket | No | number | | |
2493 lowEndOfLatencyBucket | No | number | | |
2494
2495.. _d_669cf98e276c9992abd27056c432bbb2:
2496
2497measurementsForVfScalingFields Model Structure
2498----------------------------------------------
2499
2500measurementsForVfScaling fields
2501
2502.. csv-table::
2503 :delim: |
2504 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2505 :widths: 20, 10, 15, 15, 30, 25
2506
2507 additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional name-value-pair fields
2508 additionalMeasurements | No | array of :ref:`namedArrayOfFields <d_38de3331d60414da3eea18e8f7e0ecf9>` | | | array of named name-value-pair arrays
2509 additionalObjects | No | array of :ref:`jsonObject <d_d8868aee802ae8e2b1e7ea1c4ecc1f54>` | | | array of JSON objects described by name, schema and other meta-information
2510 codecUsageArray | No | array of :ref:`codecsInUse <d_df249c51a416f54e5609f2ffffe059c0>` | | | array of codecs in use
2511 concurrentSessions | No | integer | | | peak concurrent sessions for the VM or VNF over the measurementInterval
2512 configuredEntities | No | integer | | | over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the VNF
2513 cpuUsageArray | No | array of :ref:`cpuUsage <d_6f081937f31c09078c8acf9212d6c449>` | | | usage of an array of CPUs
2514 diskUsageArray | No | array of :ref:`diskUsage <d_bb7a69764c21219953df76826934938e>` | | | usage of an array of disks
2515 featureUsageArray | No | array of :ref:`featuresInUse <d_76d7f35861442236cee9f716ea1e1540>` | | | array of features in use
2516 filesystemUsageArray | No | array of :ref:`filesystemUsage <d_18e1fa5fd6774deefce826b075f8b6e7>` | | | filesystem usage of the VM on which the VNFC reporting the event is running
2517 latencyDistribution | No | array of :ref:`latencyBucketMeasure <d_dc21244021b6cb0e0af16166e4600d99>` | | | array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges
2518 meanRequestLatency | No | number | | | mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running
2519 measurementInterval | Yes | number | | | interval over which measurements are being reported in seconds
2520 measurementsForVfScalingVersion | Yes | number | | | version of the measurementsForVfScaling block
2521 memoryUsageArray | No | array of :ref:`memoryUsage <d_7a758ee807f435a8ba5568e6da6ed597>` | | | memory usage of an array of VMs
2522 numberOfMediaPortsInUse | No | integer | | | number of media ports in use
2523 requestRate | No | number | | | peak rate of service requests per second to the VNF over the measurementInterval
2524 vNicPerformanceArray | No | array of :ref:`vNicPerformance <d_b845a2955da4c78bef3ba4d50021a240>` | | | usage of an array of virtual network interface cards
2525 vnfcScalingMetric | No | integer | | | represents busy-ness of the VNF from 0 to 100 as reported by the VNFC
2526
2527.. _d_7a758ee807f435a8ba5568e6da6ed597:
2528
2529memoryUsage Model Structure
2530---------------------------
2531
2532memory usage of an identified virtual machine
2533
2534.. csv-table::
2535 :delim: |
2536 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2537 :widths: 20, 10, 15, 15, 30, 25
2538
2539 memoryBuffered | No | number | | | kibibytes of temporary storage for raw disk blocks
2540 memoryCached | No | number | | | kibibytes of memory used for cache
2541 memoryConfigured | No | number | | | kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running
2542 memoryFree | Yes | number | | | kibibytes of physical RAM left unused by the system
2543 memorySlabRecl | No | number | | | the part of the slab that can be reclaimed such as caches measured in kibibytes
2544 memorySlabUnrecl | No | number | | | the part of the slab that cannot be reclaimed even when lacking memory measured in kibibytes
2545 memoryUsed | Yes | number | | | total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes
2546 vmIdentifier | Yes | string | | | virtual machine identifier associated with the memory metrics
2547
2548.. _d_dc18fe1d28fe3ef664c3f4ab777d8424:
2549
2550mobileFlowFields Model Structure
2551--------------------------------
2552
2553mobileFlow fields
2554
2555.. csv-table::
2556 :delim: |
2557 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2558 :widths: 20, 10, 15, 15, 30, 25
2559
2560 additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional mobileFlow fields if needed
2561 appProtocolType | No | string | | | application protocol
2562 appProtocolVersion | No | string | | | application protocol version
2563 applicationType | No | string | | | Application type inferred
2564 cid | No | string | | | cell id
2565 connectionType | No | string | | | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc
2566 ecgi | No | string | | | Evolved Cell Global Id
2567 flowDirection | Yes | string | | | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow
2568 gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` | | |
2569 gtpProtocolType | No | string | | | GTP protocol
2570 gtpVersion | No | string | | | GTP protocol version
2571 httpHeader | No | string | | | HTTP request header, if the flow connects to a node referenced by HTTP
2572 imei | No | string | | | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device
2573 imsi | No | string | | | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device
2574 ipProtocolType | Yes | string | | | IP protocol type e.g., TCP, UDP, RTP...
2575 ipVersion | Yes | string | | | IP protocol version e.g., IPv4, IPv6
2576 lac | No | string | | | location area code
2577 mcc | No | string | | | mobile country code
2578 mnc | No | string | | | mobile network code
2579 mobileFlowFieldsVersion | Yes | number | | | version of the mobileFlowFields block
2580 msisdn | No | string | | | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device
2581 otherEndpointIpAddress | Yes | string | | | IP address for the other endpoint, as used for the flow being reported on
2582 otherEndpointPort | Yes | integer | | | IP Port for the reporting entity, as used for the flow being reported on
2583 otherFunctionalRole | No | string | | | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...
2584 rac | No | string | | | routing area code
2585 radioAccessTechnology | No | string | | | Radio Access Technology e.g., 2G, 3G, LTE
2586 reportingEndpointIpAddr | Yes | string | | | IP address for the reporting entity, as used for the flow being reported on
2587 reportingEndpointPort | Yes | integer | | | IP port for the reporting entity, as used for the flow being reported on
2588 sac | No | string | | | service area code
2589 samplingAlgorithm | No | integer | | | Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied
2590 tac | No | string | | | transport area code
2591 tunnelId | No | string | | | tunnel identifier
2592 vlanId | No | string | | | VLAN identifier used by this flow
2593
2594.. _d_38de3331d60414da3eea18e8f7e0ecf9:
2595
2596namedArrayOfFields Model Structure
2597----------------------------------
2598
2599an array of name value pairs along with a name for the array
2600
2601.. csv-table::
2602 :delim: |
2603 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2604 :widths: 20, 10, 15, 15, 30, 25
2605
2606 arrayOfFields | Yes | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name value pairs
2607 name | Yes | string | | |
2608
2609.. _d_5a79cd7ce784d60fd832d9c7c0a24322:
2610
2611otherFields Model Structure
2612---------------------------
2613
2614fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration
2615
2616.. csv-table::
2617 :delim: |
2618 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2619 :widths: 20, 10, 15, 15, 30, 25
2620
2621 hashOfNameValuePairArrays | No | array of :ref:`namedArrayOfFields <d_38de3331d60414da3eea18e8f7e0ecf9>` | | | array of named name-value-pair arrays
2622 jsonObjects | No | array of :ref:`jsonObject <d_d8868aee802ae8e2b1e7ea1c4ecc1f54>` | | | array of JSON objects described by name, schema and other meta-information
2623 nameValuePairs | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name-value pairs
2624 otherFieldsVersion | Yes | number | | | version of the otherFields block
2625
2626.. _d_6747334473cf2b305fe43b61a40656e1:
2627
2628requestError Model Structure
2629----------------------------
2630
2631standard request error data structure
2632
2633.. csv-table::
2634 :delim: |
2635 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2636 :widths: 20, 10, 15, 15, 30, 25
2637
2638 messageId | Yes | string | | | Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception
2639 text | Yes | string | | | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1
2640 url | No | string | | | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents
2641 variables | No | string | | | List of zero or more strings that represent the contents of the variables used by the message text
2642
2643.. _d_c3e191f0b26ddd68f927ac0c8b551c5e:
2644
2645sipSignalingFields Model Structure
2646----------------------------------
2647
2648sip signaling fields
2649
2650.. csv-table::
2651 :delim: |
2652 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2653 :widths: 20, 10, 15, 15, 30, 25
2654
2655 additionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional sip signaling fields if needed
2656 compressedSip | No | string | | | the full SIP request/response including headers and bodies
2657 correlator | Yes | string | | | this is the same for all events on this call
2658 localIpAddress | Yes | string | | | IP address on VNF
2659 localPort | Yes | string | | | port on VNF
2660 remoteIpAddress | Yes | string | | | IP address of peer endpoint
2661 remotePort | Yes | string | | | port of peer endpoint
2662 sipSignalingFieldsVersion | Yes | number | | | version of the sipSignalingFields block
2663 summarySip | No | string | | | the SIP Method or Response (INVITE, 200 OK, BYE, etc)
2664 vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | |
2665
2666.. _d_c5450f1a263d0a2b0c64c96119f7d759:
2667
2668stateChangeFields Model Structure
2669---------------------------------
2670
2671stateChange fields
2672
2673.. csv-table::
2674 :delim: |
2675 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2676 :widths: 20, 10, 15, 15, 30, 25
2677
2678 additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional stateChange fields if needed
2679 newState | Yes | string | | {'enum': ['inService', 'maintenance', 'outOfService']} | new state of the entity
2680 oldState | Yes | string | | {'enum': ['inService', 'maintenance', 'outOfService']} | previous state of the entity
2681 stateChangeFieldsVersion | Yes | number | | | version of the stateChangeFields block
2682 stateInterface | Yes | string | | | card or port name of the entity that changed state
2683
2684.. _d_52877eda2d273b282063857f97fa7ff4:
2685
2686suppressedNvPairs Model Structure
2687---------------------------------
2688
2689List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling
2690
2691.. csv-table::
2692 :delim: |
2693 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2694 :widths: 20, 10, 15, 15, 30, 25
2695
2696 nvPairFieldName | Yes | string | | | Name of the field within which are the nvpair names to suppress
2697 suppressedNvPairNames | Yes | array of string | | | Array of nvpair names to suppress within the nvpairFieldName
2698
2699.. _d_782271970af04a3b0e5a5da9b30996d2:
2700
2701syslogFields Model Structure
2702----------------------------
2703
2704sysLog fields
2705
2706.. csv-table::
2707 :delim: |
2708 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2709 :widths: 20, 10, 15, 15, 30, 25
2710
2711 additionalFields | No | string | | | additional syslog fields if needed provided as name=value delimited by a pipe | symbol, for example: 'name1=value1|name2=value2|'
2712 eventSourceHost | No | string | | | hostname of the device
2713 eventSourceType | Yes | string | | | type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction
2714 syslogFacility | No | integer | | | numeric code from 0 to 23 for facility--see table in documentation
2715 syslogFieldsVersion | Yes | number | | | version of the syslogFields block
2716 syslogMsg | Yes | string | | | syslog message
2717 syslogPri | No | integer | | | 0-192 combined severity and facility
2718 syslogProc | No | string | | | identifies the application that originated the message
2719 syslogProcId | No | number | | | a change in the value of this field indicates a discontinuity in syslog reporting
2720 syslogSData | No | string | | | syslog structured data consisting of a structured data Id followed by a set of key value pairs
2721 syslogSdId | No | string | | | 0-32 char in format name@number for example ourSDID@32473
2722 syslogSev | No | string | | {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} | numerical Code for severity derived from syslogPri as remaider of syslogPri / 8
2723 syslogTag | Yes | string | | | msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided
2724 syslogVer | No | number | | | IANA assigned version of the syslog protocol specification - typically 1
2725
2726.. _d_bd95ac8a5536a5bb5e6a0de7e64b9f20:
2727
2728thresholdCrossingAlertFields Model Structure
2729--------------------------------------------
2730
2731fields specific to threshold crossing alert events
2732
2733.. csv-table::
2734 :delim: |
2735 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2736 :widths: 20, 10, 15, 15, 30, 25
2737
2738 additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional threshold crossing alert fields if needed
2739 additionalParameters | Yes | array of :ref:`counter <d_6e043350cba5faafe21de49c2f6fd745>` | | | performance counters
2740 alertAction | Yes | string | | {'enum': ['CLEAR', 'CONT', 'SET']} | Event action
2741 alertDescription | Yes | string | | | Unique short alert description such as IF-SHUB-ERRDROP
2742 alertType | Yes | string | | {'enum': ['CARD-ANOMALY', 'ELEMENT-ANOMALY', 'INTERFACE-ANOMALY', 'SERVICE-ANOMALY']} | Event type
2743 alertValue | No | string | | | Calculated API value (if applicable)
2744 associatedAlertIdList | No | array of string | | | List of eventIds associated with the event being reported
2745 collectionTimestamp | Yes | string | | | Time when the performance collector picked up the data; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800
2746 dataCollector | No | string | | | Specific performance collector instance used
2747 elementType | No | string | | | type of network element - internal ATT field
2748 eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity or priority
2749 eventStartTimestamp | Yes | string | | | Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800
2750 interfaceName | No | string | | | Physical or logical port or card (if applicable)
2751 networkService | No | string | | | network name - internal ATT field
2752 possibleRootCause | No | string | | | Reserved for future use
2753 thresholdCrossingFieldsVersion | Yes | number | | | version of the thresholdCrossingAlertFields block
2754
2755.. _d_b845a2955da4c78bef3ba4d50021a240:
2756
2757vNicPerformance Model Structure
2758-------------------------------
2759
2760describes the performance and errors of an identified virtual network interface card
2761
2762.. csv-table::
2763 :delim: |
2764 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2765 :widths: 20, 10, 15, 15, 30, 25
2766
2767 receivedBroadcastPacketsAccumulated | No | number | | | Cumulative count of broadcast packets received as read at the end of the measurement interval
2768 receivedBroadcastPacketsDelta | No | number | | | Count of broadcast packets received within the measurement interval
2769 receivedDiscardedPacketsAccumulated | No | number | | | Cumulative count of discarded packets received as read at the end of the measurement interval
2770 receivedDiscardedPacketsDelta | No | number | | | Count of discarded packets received within the measurement interval
2771 receivedErrorPacketsAccumulated | No | number | | | Cumulative count of error packets received as read at the end of the measurement interval
2772 receivedErrorPacketsDelta | No | number | | | Count of error packets received within the measurement interval
2773 receivedMulticastPacketsAccumulated | No | number | | | Cumulative count of multicast packets received as read at the end of the measurement interval
2774 receivedMulticastPacketsDelta | No | number | | | Count of multicast packets received within the measurement interval
2775 receivedOctetsAccumulated | No | number | | | Cumulative count of octets received as read at the end of the measurement interval
2776 receivedOctetsDelta | No | number | | | Count of octets received within the measurement interval
2777 receivedTotalPacketsAccumulated | No | number | | | Cumulative count of all packets received as read at the end of the measurement interval
2778 receivedTotalPacketsDelta | No | number | | | Count of all packets received within the measurement interval
2779 receivedUnicastPacketsAccumulated | No | number | | | Cumulative count of unicast packets received as read at the end of the measurement interval
2780 receivedUnicastPacketsDelta | No | number | | | Count of unicast packets received within the measurement interval
2781 transmittedBroadcastPacketsAccumulated | No | number | | | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval
2782 transmittedBroadcastPacketsDelta | No | number | | | Count of broadcast packets transmitted within the measurement interval
2783 transmittedDiscardedPacketsAccumulated | No | number | | | Cumulative count of discarded packets transmitted as read at the end of the measurement interval
2784 transmittedDiscardedPacketsDelta | No | number | | | Count of discarded packets transmitted within the measurement interval
2785 transmittedErrorPacketsAccumulated | No | number | | | Cumulative count of error packets transmitted as read at the end of the measurement interval
2786 transmittedErrorPacketsDelta | No | number | | | Count of error packets transmitted within the measurement interval
2787 transmittedMulticastPacketsAccumulated | No | number | | | Cumulative count of multicast packets transmitted as read at the end of the measurement interval
2788 transmittedMulticastPacketsDelta | No | number | | | Count of multicast packets transmitted within the measurement interval
2789 transmittedOctetsAccumulated | No | number | | | Cumulative count of octets transmitted as read at the end of the measurement interval
2790 transmittedOctetsDelta | No | number | | | Count of octets transmitted within the measurement interval
2791 transmittedTotalPacketsAccumulated | No | number | | | Cumulative count of all packets transmitted as read at the end of the measurement interval
2792 transmittedTotalPacketsDelta | No | number | | | Count of all packets transmitted within the measurement interval
2793 transmittedUnicastPacketsAccumulated | No | number | | | Cumulative count of unicast packets transmitted as read at the end of the measurement interval
2794 transmittedUnicastPacketsDelta | No | number | | | Count of unicast packets transmitted within the measurement interval
2795 vNicIdentifier | Yes | string | | | vNic identification
2796 valuesAreSuspect | Yes | string | | {'enum': ['true', 'false']} | Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions
2797
2798.. _d_d694eebbbc0078612d2ba22e0cbf814c:
2799
2800vendorVnfNameFields Model Structure
2801-----------------------------------
2802
2803provides vendor, vnf and vfModule identifying information
2804
2805.. csv-table::
2806 :delim: |
2807 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2808 :widths: 20, 10, 15, 15, 30, 25
2809
2810 vendorName | Yes | string | | | VNF vendor name
2811 vfModuleName | No | string | | | ASDC vfModuleName for the vfModule generating the event
2812 vnfName | No | string | | | ASDC modelName for the VNF generating the event
2813
2814.. _d_9551641bd1c775d9fcf4e45353de8e43:
2815
2816voiceQualityFields Model Structure
2817----------------------------------
2818
2819provides statistics related to customer facing voice products
2820
2821.. csv-table::
2822 :delim: |
2823 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2824 :widths: 20, 10, 15, 15, 30, 25
2825
2826 additionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional voice quality fields if needed
2827 calleeSideCodec | Yes | string | | | callee codec for the call
2828 callerSideCodec | Yes | string | | | caller codec for the call
2829 correlator | Yes | string | | | this is the same for all events on this call
2830 endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` | | |
2831 midCallRtcp | Yes | string | | | Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers
2832 phoneNumber | No | string | | | phone number associated with the correlator
2833 vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | |
2834 voiceQualityFieldsVersion | Yes | number | | | version of the voiceQualityFields block
2835