docs/sections/apis/ves.rst

   1 VES Collector 1.3.1
   2 ===================
   3
   4 .. toctree::
   5     :maxdepth: 3
   6
   7
   8 Description
   9 ~~~~~~~~~~~
  10
  11 Virtual 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
  16 Contact Information
  17 ~~~~~~~~~~~~~~~~~~~
  18
  19
  20
  21 dcae@lists.openecomp.org
  22
  23
  24
  25
  26
  27
  28 Security
  29 ~~~~~~~~
  30
  31
  32 .. _securities_basicAuth:
  33
  34 basicAuth (HTTP Basic Authentication)
  35 -------------------------------------
  36
  37
  38 *HTTP Basic Authentication. Works over `HTTP` and `HTTPS`*
  39
  40
  41
  42
  43
  44 DEFAULT
  45 ~~~~~~~
  46
  47
  48
  49
  50 GET ``/healthcheck``
  51 --------------------
  52
  53
  54
  55
  56
  57 Request
  58 +++++++
  59
  60
  61 Responses
  62 +++++++++
  63
  64 **200**
  65 ^^^^^^^
  66
  67 healthcheck successful
  68
  69
  70
  71
  72
  73
  74 POST ``/eventListener/v5``
  75 --------------------------
  76
  77
  78
  79 Description
  80 +++++++++++
  81
  82 .. raw:: html
  83
  84     uri for posting VES event objects
  85
  86
  87 Request
  88 +++++++
  89
  90
  91
  92 .. _d_f598222d7a83ca9c3538556b263682d1:
  93
  94 Body
  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
 951 Responses
 952 +++++++++
 953
 954 **200**
 955 ^^^^^^^
 956
 957 VES Event Accepted.
 958
 959
 960 Type: :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
 975 Bad request provided
 976
 977
 978 Type: :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
 993 Unauthorized request
 994
 995
 996 Type: :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
1011 Service Unavailable
1012
1013
1014 Type: :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
1028 Security
1029 ++++++++
1030
1031 .. csv-table::
1032     :header: "Security Schema", "Scopes"
1033     :widths: 15, 45
1034
1035         :ref:`basicAuth <securities_basicAuth>`, ""
1036
1037
1038 POST ``/eventListener/v5/eventBatch``
1039 -------------------------------------
1040
1041
1042
1043 Description
1044 +++++++++++
1045
1046 .. raw:: html
1047
1048     uri for posting VES batch event objects
1049
1050
1051 Request
1052 +++++++
1053
1054
1055
1056
1057 Body
1058 ^^^^
1059
1060 .. csv-table::
1061     :delim: |
1062     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1063     :widths: 20, 10, 15, 15, 30, 25
1064
1065         event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` |  |  |
1066
1067 .. code-block:: javascript
1068
1069     {
1070         "event": {
1071             "commonEventHeader": {
1072                 "domain": "fault",
1073                 "eventId": "somestring",
1074                 "eventName": "somestring",
1075                 "eventType": "somestring",
1076                 "internalHeaderFields": {},
1077                 "lastEpochMicrosec": 1,
1078                 "nfNamingCode": "somestring",
1079                 "nfcNamingCode": "somestring",
1080                 "priority": "High",
1081                 "reportingEntityId": "somestring",
1082                 "reportingEntityName": "somestring",
1083                 "sequence": 1,
1084                 "sourceId": "somestring",
1085                 "sourceName": "somestring",
1086                 "startEpochMicrosec": 1,
1087                 "version": 1
1088             },
1089             "faultFields": {
1090                 "alarmAdditionalInformation": [
1091                     {
1092                         "name": "somestring",
1093                         "value": "somestring"
1094                     },
1095                     {
1096                         "name": "somestring",
1097                         "value": "somestring"
1098                     }
1099                 ],
1100                 "alarmCondition": "somestring",
1101                 "alarmInterfaceA": "somestring",
1102                 "eventCategory": "somestring",
1103                 "eventSeverity": "CRITICAL",
1104                 "eventSourceType": "somestring",
1105                 "faultFieldsVersion": 1,
1106                 "specificProblem": "somestring",
1107                 "vfStatus": "Active"
1108             },
1109             "heartbeatFields": {
1110                 "additionalFields": [
1111                     {
1112                         "name": "somestring",
1113                         "value": "somestring"
1114                     },
1115                     {
1116                         "name": "somestring",
1117                         "value": "somestring"
1118                     }
1119                 ],
1120                 "heartbeatFieldsVersion": 1,
1121                 "heartbeatInterval": 1
1122             },
1123             "measurementsForVfScalingFields": {
1124                 "additionalFields": [
1125                     {
1126                         "name": "somestring",
1127                         "value": "somestring"
1128                     },
1129                     {
1130                         "name": "somestring",
1131                         "value": "somestring"
1132                     }
1133                 ],
1134                 "additionalMeasurements": [
1135                     {
1136                         "arrayOfFields": [
1137                             {
1138                                 "name": "somestring",
1139                                 "value": "somestring"
1140                             },
1141                             {
1142                                 "name": "somestring",
1143                                 "value": "somestring"
1144                             }
1145                         ],
1146                         "name": "somestring"
1147                     },
1148                     {
1149                         "arrayOfFields": [
1150                             {
1151                                 "name": "somestring",
1152                                 "value": "somestring"
1153                             },
1154                             {
1155                                 "name": "somestring",
1156                                 "value": "somestring"
1157                             }
1158                         ],
1159                         "name": "somestring"
1160                     }
1161                 ],
1162                 "additionalObjects": [
1163                     {
1164                         "nfSubscribedObjectName": "somestring",
1165                         "nfSubscriptionId": "somestring",
1166                         "objectInstances": [
1167                             {
1168                                 "objectInstance": {},
1169                                 "objectInstanceEpochMicrosec": 1,
1170                                 "objectKeys": [
1171                                     {
1172                                         "keyName": "somestring",
1173                                         "keyOrder": 1,
1174                                         "keyValue": "somestring"
1175                                     },
1176                                     {
1177                                         "keyName": "somestring",
1178                                         "keyOrder": 1,
1179                                         "keyValue": "somestring"
1180                                     }
1181                                 ]
1182                             },
1183                             {
1184                                 "objectInstance": {},
1185                                 "objectInstanceEpochMicrosec": 1,
1186                                 "objectKeys": [
1187                                     {
1188                                         "keyName": "somestring",
1189                                         "keyOrder": 1,
1190                                         "keyValue": "somestring"
1191                                     },
1192                                     {
1193                                         "keyName": "somestring",
1194                                         "keyOrder": 1,
1195                                         "keyValue": "somestring"
1196                                     }
1197                                 ]
1198                             }
1199                         ],
1200                         "objectName": "somestring",
1201                         "objectSchema": "somestring",
1202                         "objectSchemaUrl": "somestring"
1203                     },
1204                     {
1205                         "nfSubscribedObjectName": "somestring",
1206                         "nfSubscriptionId": "somestring",
1207                         "objectInstances": [
1208                             {
1209                                 "objectInstance": {},
1210                                 "objectInstanceEpochMicrosec": 1,
1211                                 "objectKeys": [
1212                                     {
1213                                         "keyName": "somestring",
1214                                         "keyOrder": 1,
1215                                         "keyValue": "somestring"
1216                                     },
1217                                     {
1218                                         "keyName": "somestring",
1219                                         "keyOrder": 1,
1220                                         "keyValue": "somestring"
1221                                     }
1222                                 ]
1223                             },
1224                             {
1225                                 "objectInstance": {},
1226                                 "objectInstanceEpochMicrosec": 1,
1227                                 "objectKeys": [
1228                                     {
1229                                         "keyName": "somestring",
1230                                         "keyOrder": 1,
1231                                         "keyValue": "somestring"
1232                                     },
1233                                     {
1234                                         "keyName": "somestring",
1235                                         "keyOrder": 1,
1236                                         "keyValue": "somestring"
1237                                     }
1238                                 ]
1239                             }
1240                         ],
1241                         "objectName": "somestring",
1242                         "objectSchema": "somestring",
1243                         "objectSchemaUrl": "somestring"
1244                     }
1245                 ],
1246                 "codecUsageArray": [
1247                     {
1248                         "codecIdentifier": "somestring",
1249                         "numberInUse": 1
1250                     },
1251                     {
1252                         "codecIdentifier": "somestring",
1253                         "numberInUse": 1
1254                     }
1255                 ],
1256                 "concurrentSessions": 1,
1257                 "configuredEntities": 1,
1258                 "cpuUsageArray": [
1259                     {
1260                         "cpuIdentifier": "somestring",
1261                         "cpuIdle": 1,
1262                         "cpuUsageInterrupt": 1,
1263                         "cpuUsageNice": 1,
1264                         "cpuUsageSoftIrq": 1,
1265                         "cpuUsageSteal": 1,
1266                         "cpuUsageSystem": 1,
1267                         "cpuUsageUser": 1,
1268                         "cpuWait": 1,
1269                         "percentUsage": 1
1270                     },
1271                     {
1272                         "cpuIdentifier": "somestring",
1273                         "cpuIdle": 1,
1274                         "cpuUsageInterrupt": 1,
1275                         "cpuUsageNice": 1,
1276                         "cpuUsageSoftIrq": 1,
1277                         "cpuUsageSteal": 1,
1278                         "cpuUsageSystem": 1,
1279                         "cpuUsageUser": 1,
1280                         "cpuWait": 1,
1281                         "percentUsage": 1
1282                     }
1283                 ],
1284                 "diskUsageArray": [
1285                     {
1286                         "diskIdentifier": "somestring",
1287                         "diskIoTimeAvg": 1,
1288                         "diskIoTimeLast": 1,
1289                         "diskIoTimeMax": 1,
1290                         "diskIoTimeMin": 1,
1291                         "diskMergedReadAvg": 1,
1292                         "diskMergedReadLast": 1,
1293                         "diskMergedReadMax": 1,
1294                         "diskMergedReadMin": 1,
1295                         "diskMergedWriteAvg": 1,
1296                         "diskMergedWriteLast": 1,
1297                         "diskMergedWriteMax": 1,
1298                         "diskMergedWriteMin": 1,
1299                         "diskOctetsReadAvg": 1,
1300                         "diskOctetsReadLast": 1,
1301                         "diskOctetsReadMax": 1,
1302                         "diskOctetsReadMin": 1,
1303                         "diskOctetsWriteAvg": 1,
1304                         "diskOctetsWriteLast": 1,
1305                         "diskOctetsWriteMax": 1,
1306                         "diskOctetsWriteMin": 1,
1307                         "diskOpsReadAvg": 1,
1308                         "diskOpsReadLast": 1,
1309                         "diskOpsReadMax": 1,
1310                         "diskOpsReadMin": 1,
1311                         "diskOpsWriteAvg": 1,
1312                         "diskOpsWriteLast": 1,
1313                         "diskOpsWriteMax": 1,
1314                         "diskOpsWriteMin": 1,
1315                         "diskPendingOperationsAvg": 1,
1316                         "diskPendingOperationsLast": 1,
1317                         "diskPendingOperationsMax": 1,
1318                         "diskPendingOperationsMin": 1,
1319                         "diskTimeReadAvg": 1,
1320                         "diskTimeReadLast": 1,
1321                         "diskTimeReadMax": 1,
1322                         "diskTimeReadMin": 1,
1323                         "diskTimeWriteAvg": 1,
1324                         "diskTimeWriteLast": 1,
1325                         "diskTimeWriteMax": 1,
1326                         "diskTimeWriteMin": 1
1327                     },
1328                     {
1329                         "diskIdentifier": "somestring",
1330                         "diskIoTimeAvg": 1,
1331                         "diskIoTimeLast": 1,
1332                         "diskIoTimeMax": 1,
1333                         "diskIoTimeMin": 1,
1334                         "diskMergedReadAvg": 1,
1335                         "diskMergedReadLast": 1,
1336                         "diskMergedReadMax": 1,
1337                         "diskMergedReadMin": 1,
1338                         "diskMergedWriteAvg": 1,
1339                         "diskMergedWriteLast": 1,
1340                         "diskMergedWriteMax": 1,
1341                         "diskMergedWriteMin": 1,
1342                         "diskOctetsReadAvg": 1,
1343                         "diskOctetsReadLast": 1,
1344                         "diskOctetsReadMax": 1,
1345                         "diskOctetsReadMin": 1,
1346                         "diskOctetsWriteAvg": 1,
1347                         "diskOctetsWriteLast": 1,
1348                         "diskOctetsWriteMax": 1,
1349                         "diskOctetsWriteMin": 1,
1350                         "diskOpsReadAvg": 1,
1351                         "diskOpsReadLast": 1,
1352                         "diskOpsReadMax": 1,
1353                         "diskOpsReadMin": 1,
1354                         "diskOpsWriteAvg": 1,
1355                         "diskOpsWriteLast": 1,
1356                         "diskOpsWriteMax": 1,
1357                         "diskOpsWriteMin": 1,
1358                         "diskPendingOperationsAvg": 1,
1359                         "diskPendingOperationsLast": 1,
1360                         "diskPendingOperationsMax": 1,
1361                         "diskPendingOperationsMin": 1,
1362                         "diskTimeReadAvg": 1,
1363                         "diskTimeReadLast": 1,
1364                         "diskTimeReadMax": 1,
1365                         "diskTimeReadMin": 1,
1366                         "diskTimeWriteAvg": 1,
1367                         "diskTimeWriteLast": 1,
1368                         "diskTimeWriteMax": 1,
1369                         "diskTimeWriteMin": 1
1370                     }
1371                 ],
1372                 "featureUsageArray": [
1373                     {
1374                         "featureIdentifier": "somestring",
1375                         "featureUtilization": 1
1376                     },
1377                     {
1378                         "featureIdentifier": "somestring",
1379                         "featureUtilization": 1
1380                     }
1381                 ],
1382                 "filesystemUsageArray": [
1383                     {
1384                         "blockConfigured": 1,
1385                         "blockIops": 1,
1386                         "blockUsed": 1,
1387                         "ephemeralConfigured": 1,
1388                         "ephemeralIops": 1,
1389                         "ephemeralUsed": 1,
1390                         "filesystemName": "somestring"
1391                     },
1392                     {
1393                         "blockConfigured": 1,
1394                         "blockIops": 1,
1395                         "blockUsed": 1,
1396                         "ephemeralConfigured": 1,
1397                         "ephemeralIops": 1,
1398                         "ephemeralUsed": 1,
1399                         "filesystemName": "somestring"
1400                     }
1401                 ],
1402                 "latencyDistribution": [
1403                     {
1404                         "countsInTheBucket": 1,
1405                         "highEndOfLatencyBucket": 1,
1406                         "lowEndOfLatencyBucket": 1
1407                     },
1408                     {
1409                         "countsInTheBucket": 1,
1410                         "highEndOfLatencyBucket": 1,
1411                         "lowEndOfLatencyBucket": 1
1412                     }
1413                 ],
1414                 "meanRequestLatency": 1,
1415                 "measurementInterval": 1,
1416                 "measurementsForVfScalingVersion": 1,
1417                 "memoryUsageArray": [
1418                     {
1419                         "memoryBuffered": 1,
1420                         "memoryCached": 1,
1421                         "memoryConfigured": 1,
1422                         "memoryFree": 1,
1423                         "memorySlabRecl": 1,
1424                         "memorySlabUnrecl": 1,
1425                         "memoryUsed": 1,
1426                         "vmIdentifier": "somestring"
1427                     },
1428                     {
1429                         "memoryBuffered": 1,
1430                         "memoryCached": 1,
1431                         "memoryConfigured": 1,
1432                         "memoryFree": 1,
1433                         "memorySlabRecl": 1,
1434                         "memorySlabUnrecl": 1,
1435                         "memoryUsed": 1,
1436                         "vmIdentifier": "somestring"
1437                     }
1438                 ],
1439                 "numberOfMediaPortsInUse": 1,
1440                 "requestRate": 1,
1441                 "vNicPerformanceArray": [
1442                     {
1443                         "receivedBroadcastPacketsAccumulated": 1,
1444                         "receivedBroadcastPacketsDelta": 1,
1445                         "receivedDiscardedPacketsAccumulated": 1,
1446                         "receivedDiscardedPacketsDelta": 1,
1447                         "receivedErrorPacketsAccumulated": 1,
1448                         "receivedErrorPacketsDelta": 1,
1449                         "receivedMulticastPacketsAccumulated": 1,
1450                         "receivedMulticastPacketsDelta": 1,
1451                         "receivedOctetsAccumulated": 1,
1452                         "receivedOctetsDelta": 1,
1453                         "receivedTotalPacketsAccumulated": 1,
1454                         "receivedTotalPacketsDelta": 1,
1455                         "receivedUnicastPacketsAccumulated": 1,
1456                         "receivedUnicastPacketsDelta": 1,
1457                         "transmittedBroadcastPacketsAccumulated": 1,
1458                         "transmittedBroadcastPacketsDelta": 1,
1459                         "transmittedDiscardedPacketsAccumulated": 1,
1460                         "transmittedDiscardedPacketsDelta": 1,
1461                         "transmittedErrorPacketsAccumulated": 1,
1462                         "transmittedErrorPacketsDelta": 1,
1463                         "transmittedMulticastPacketsAccumulated": 1,
1464                         "transmittedMulticastPacketsDelta": 1,
1465                         "transmittedOctetsAccumulated": 1,
1466                         "transmittedOctetsDelta": 1,
1467                         "transmittedTotalPacketsAccumulated": 1,
1468                         "transmittedTotalPacketsDelta": 1,
1469                         "transmittedUnicastPacketsAccumulated": 1,
1470                         "transmittedUnicastPacketsDelta": 1,
1471                         "vNicIdentifier": "somestring",
1472                         "valuesAreSuspect": "true"
1473                     },
1474                     {
1475                         "receivedBroadcastPacketsAccumulated": 1,
1476                         "receivedBroadcastPacketsDelta": 1,
1477                         "receivedDiscardedPacketsAccumulated": 1,
1478                         "receivedDiscardedPacketsDelta": 1,
1479                         "receivedErrorPacketsAccumulated": 1,
1480                         "receivedErrorPacketsDelta": 1,
1481                         "receivedMulticastPacketsAccumulated": 1,
1482                         "receivedMulticastPacketsDelta": 1,
1483                         "receivedOctetsAccumulated": 1,
1484                         "receivedOctetsDelta": 1,
1485                         "receivedTotalPacketsAccumulated": 1,
1486                         "receivedTotalPacketsDelta": 1,
1487                         "receivedUnicastPacketsAccumulated": 1,
1488                         "receivedUnicastPacketsDelta": 1,
1489                         "transmittedBroadcastPacketsAccumulated": 1,
1490                         "transmittedBroadcastPacketsDelta": 1,
1491                         "transmittedDiscardedPacketsAccumulated": 1,
1492                         "transmittedDiscardedPacketsDelta": 1,
1493                         "transmittedErrorPacketsAccumulated": 1,
1494                         "transmittedErrorPacketsDelta": 1,
1495                         "transmittedMulticastPacketsAccumulated": 1,
1496                         "transmittedMulticastPacketsDelta": 1,
1497                         "transmittedOctetsAccumulated": 1,
1498                         "transmittedOctetsDelta": 1,
1499                         "transmittedTotalPacketsAccumulated": 1,
1500                         "transmittedTotalPacketsDelta": 1,
1501                         "transmittedUnicastPacketsAccumulated": 1,
1502                         "transmittedUnicastPacketsDelta": 1,
1503                         "vNicIdentifier": "somestring",
1504                         "valuesAreSuspect": "true"
1505                     }
1506                 ],
1507                 "vnfcScalingMetric": 1
1508             },
1509             "mobileFlowFields": {
1510                 "additionalFields": [
1511                     {
1512                         "name": "somestring",
1513                         "value": "somestring"
1514                     },
1515                     {
1516                         "name": "somestring",
1517                         "value": "somestring"
1518                     }
1519                 ],
1520                 "appProtocolType": "somestring",
1521                 "appProtocolVersion": "somestring",
1522                 "applicationType": "somestring",
1523                 "cid": "somestring",
1524                 "connectionType": "somestring",
1525                 "ecgi": "somestring",
1526                 "flowDirection": "somestring",
1527                 "gtpPerFlowMetrics": {
1528                     "avgBitErrorRate": 1,
1529                     "avgPacketDelayVariation": 1,
1530                     "avgPacketLatency": 1,
1531                     "avgReceiveThroughput": 1,
1532                     "avgTransmitThroughput": 1,
1533                     "durConnectionFailedStatus": 1,
1534                     "durTunnelFailedStatus": 1,
1535                     "flowActivatedBy": "somestring",
1536                     "flowActivationEpoch": 1,
1537                     "flowActivationMicrosec": 1,
1538                     "flowActivationTime": "somestring",
1539                     "flowDeactivatedBy": "somestring",
1540                     "flowDeactivationEpoch": 1,
1541                     "flowDeactivationMicrosec": 1,
1542                     "flowDeactivationTime": "somestring",
1543                     "flowStatus": "somestring",
1544                     "gtpConnectionStatus": "somestring",
1545                     "gtpTunnelStatus": "somestring",
1546                     "ipTosCountList": [
1547                         [
1548                             1,
1549                             1
1550                         ],
1551                         [
1552                             1,
1553                             1
1554                         ]
1555                     ],
1556                     "ipTosList": [
1557                         "somestring",
1558                         "somestring"
1559                     ],
1560                     "largePacketRtt": 1,
1561                     "largePacketThreshold": 1,
1562                     "maxPacketDelayVariation": 1,
1563                     "maxReceiveBitRate": 1,
1564                     "maxTransmitBitRate": 1,
1565                     "mobileQciCosCountList": [
1566                         [
1567                             1,
1568                             1
1569                         ],
1570                         [
1571                             1,
1572                             1
1573                         ]
1574                     ],
1575                     "mobileQciCosList": [
1576                         "somestring",
1577                         "somestring"
1578                     ],
1579                     "numActivationFailures": 1,
1580                     "numBitErrors": 1,
1581                     "numBytesReceived": 1,
1582                     "numBytesTransmitted": 1,
1583                     "numDroppedPackets": 1,
1584                     "numGtpEchoFailures": 1,
1585                     "numGtpTunnelErrors": 1,
1586                     "numHttpErrors": 1,
1587                     "numL7BytesReceived": 1,
1588                     "numL7BytesTransmitted": 1,
1589                     "numLostPackets": 1,
1590                     "numOutOfOrderPackets": 1,
1591                     "numPacketErrors": 1,
1592                     "numPacketsReceivedExclRetrans": 1,
1593                     "numPacketsReceivedInclRetrans": 1,
1594                     "numPacketsTransmittedInclRetrans": 1,
1595                     "numRetries": 1,
1596                     "numTimeouts": 1,
1597                     "numTunneledL7BytesReceived": 1,
1598                     "roundTripTime": 1,
1599                     "tcpFlagCountList": [
1600                         [
1601                             1,
1602                             1
1603                         ],
1604                         [
1605                             1,
1606                             1
1607                         ]
1608                     ],
1609                     "tcpFlagList": [
1610                         "somestring",
1611                         "somestring"
1612                     ],
1613                     "timeToFirstByte": 1
1614                 },
1615                 "gtpProtocolType": "somestring",
1616                 "gtpVersion": "somestring",
1617                 "httpHeader": "somestring",
1618                 "imei": "somestring",
1619                 "imsi": "somestring",
1620                 "ipProtocolType": "somestring",
1621                 "ipVersion": "somestring",
1622                 "lac": "somestring",
1623                 "mcc": "somestring",
1624                 "mnc": "somestring",
1625                 "mobileFlowFieldsVersion": 1,
1626                 "msisdn": "somestring",
1627                 "otherEndpointIpAddress": "somestring",
1628                 "otherEndpointPort": 1,
1629                 "otherFunctionalRole": "somestring",
1630                 "rac": "somestring",
1631                 "radioAccessTechnology": "somestring",
1632                 "reportingEndpointIpAddr": "somestring",
1633                 "reportingEndpointPort": 1,
1634                 "sac": "somestring",
1635                 "samplingAlgorithm": 1,
1636                 "tac": "somestring",
1637                 "tunnelId": "somestring",
1638                 "vlanId": "somestring"
1639             },
1640             "otherFields": {
1641                 "hashOfNameValuePairArrays": [
1642                     {
1643                         "arrayOfFields": [
1644                             {
1645                                 "name": "somestring",
1646                                 "value": "somestring"
1647                             },
1648                             {
1649                                 "name": "somestring",
1650                                 "value": "somestring"
1651                             }
1652                         ],
1653                         "name": "somestring"
1654                     },
1655                     {
1656                         "arrayOfFields": [
1657                             {
1658                                 "name": "somestring",
1659                                 "value": "somestring"
1660                             },
1661                             {
1662                                 "name": "somestring",
1663                                 "value": "somestring"
1664                             }
1665                         ],
1666                         "name": "somestring"
1667                     }
1668                 ],
1669                 "jsonObjects": [
1670                     {
1671                         "nfSubscribedObjectName": "somestring",
1672                         "nfSubscriptionId": "somestring",
1673                         "objectInstances": [
1674                             {
1675                                 "objectInstance": {},
1676                                 "objectInstanceEpochMicrosec": 1,
1677                                 "objectKeys": [
1678                                     {
1679                                         "keyName": "somestring",
1680                                         "keyOrder": 1,
1681                                         "keyValue": "somestring"
1682                                     },
1683                                     {
1684                                         "keyName": "somestring",
1685                                         "keyOrder": 1,
1686                                         "keyValue": "somestring"
1687                                     }
1688                                 ]
1689                             },
1690                             {
1691                                 "objectInstance": {},
1692                                 "objectInstanceEpochMicrosec": 1,
1693                                 "objectKeys": [
1694                                     {
1695                                         "keyName": "somestring",
1696                                         "keyOrder": 1,
1697                                         "keyValue": "somestring"
1698                                     },
1699                                     {
1700                                         "keyName": "somestring",
1701                                         "keyOrder": 1,
1702                                         "keyValue": "somestring"
1703                                     }
1704                                 ]
1705                             }
1706                         ],
1707                         "objectName": "somestring",
1708                         "objectSchema": "somestring",
1709                         "objectSchemaUrl": "somestring"
1710                     },
1711                     {
1712                         "nfSubscribedObjectName": "somestring",
1713                         "nfSubscriptionId": "somestring",
1714                         "objectInstances": [
1715                             {
1716                                 "objectInstance": {},
1717                                 "objectInstanceEpochMicrosec": 1,
1718                                 "objectKeys": [
1719                                     {
1720                                         "keyName": "somestring",
1721                                         "keyOrder": 1,
1722                                         "keyValue": "somestring"
1723                                     },
1724                                     {
1725                                         "keyName": "somestring",
1726                                         "keyOrder": 1,
1727                                         "keyValue": "somestring"
1728                                     }
1729                                 ]
1730                             },
1731                             {
1732                                 "objectInstance": {},
1733                                 "objectInstanceEpochMicrosec": 1,
1734                                 "objectKeys": [
1735                                     {
1736                                         "keyName": "somestring",
1737                                         "keyOrder": 1,
1738                                         "keyValue": "somestring"
1739                                     },
1740                                     {
1741                                         "keyName": "somestring",
1742                                         "keyOrder": 1,
1743                                         "keyValue": "somestring"
1744                                     }
1745                                 ]
1746                             }
1747                         ],
1748                         "objectName": "somestring",
1749                         "objectSchema": "somestring",
1750                         "objectSchemaUrl": "somestring"
1751                     }
1752                 ],
1753                 "nameValuePairs": [
1754                     {
1755                         "name": "somestring",
1756                         "value": "somestring"
1757                     },
1758                     {
1759                         "name": "somestring",
1760                         "value": "somestring"
1761                     }
1762                 ],
1763                 "otherFieldsVersion": 1
1764             },
1765             "sipSignalingFields": {
1766                 "additionalInformation": [
1767                     {
1768                         "name": "somestring",
1769                         "value": "somestring"
1770                     },
1771                     {
1772                         "name": "somestring",
1773                         "value": "somestring"
1774                     }
1775                 ],
1776                 "compressedSip": "somestring",
1777                 "correlator": "somestring",
1778                 "localIpAddress": "somestring",
1779                 "localPort": "somestring",
1780                 "remoteIpAddress": "somestring",
1781                 "remotePort": "somestring",
1782                 "sipSignalingFieldsVersion": 1,
1783                 "summarySip": "somestring",
1784                 "vendorVnfNameFields": {
1785                     "vendorName": "somestring",
1786                     "vfModuleName": "somestring",
1787                     "vnfName": "somestring"
1788                 }
1789             },
1790             "stateChangeFields": {
1791                 "additionalFields": [
1792                     {
1793                         "name": "somestring",
1794                         "value": "somestring"
1795                     },
1796                     {
1797                         "name": "somestring",
1798                         "value": "somestring"
1799                     }
1800                 ],
1801                 "newState": "inService",
1802                 "oldState": "inService",
1803                 "stateChangeFieldsVersion": 1,
1804                 "stateInterface": "somestring"
1805             },
1806             "syslogFields": {
1807                 "additionalFields": "somestring",
1808                 "eventSourceHost": "somestring",
1809                 "eventSourceType": "somestring",
1810                 "syslogFacility": 1,
1811                 "syslogFieldsVersion": 1,
1812                 "syslogMsg": "somestring",
1813                 "syslogPri": 1,
1814                 "syslogProc": "somestring",
1815                 "syslogProcId": 1,
1816                 "syslogSData": "somestring",
1817                 "syslogSdId": "somestring",
1818                 "syslogSev": "Alert",
1819                 "syslogTag": "somestring",
1820                 "syslogVer": 1
1821             },
1822             "thresholdCrossingAlertFields": {
1823                 "additionalFields": [
1824                     {
1825                         "name": "somestring",
1826                         "value": "somestring"
1827                     },
1828                     {
1829                         "name": "somestring",
1830                         "value": "somestring"
1831                     }
1832                 ],
1833                 "additionalParameters": [
1834                     {
1835                         "criticality": "CRIT",
1836                         "name": "somestring",
1837                         "thresholdCrossed": "somestring",
1838                         "value": "somestring"
1839                     },
1840                     {
1841                         "criticality": "CRIT",
1842                         "name": "somestring",
1843                         "thresholdCrossed": "somestring",
1844                         "value": "somestring"
1845                     }
1846                 ],
1847                 "alertAction": "CLEAR",
1848                 "alertDescription": "somestring",
1849                 "alertType": "CARD-ANOMALY",
1850                 "alertValue": "somestring",
1851                 "associatedAlertIdList": [
1852                     "somestring",
1853                     "somestring"
1854                 ],
1855                 "collectionTimestamp": "somestring",
1856                 "dataCollector": "somestring",
1857                 "elementType": "somestring",
1858                 "eventSeverity": "CRITICAL",
1859                 "eventStartTimestamp": "somestring",
1860                 "interfaceName": "somestring",
1861                 "networkService": "somestring",
1862                 "possibleRootCause": "somestring",
1863                 "thresholdCrossingFieldsVersion": 1
1864             },
1865             "voiceQualityFields": {
1866                 "additionalInformation": [
1867                     {
1868                         "name": "somestring",
1869                         "value": "somestring"
1870                     },
1871                     {
1872                         "name": "somestring",
1873                         "value": "somestring"
1874                     }
1875                 ],
1876                 "calleeSideCodec": "somestring",
1877                 "callerSideCodec": "somestring",
1878                 "correlator": "somestring",
1879                 "endOfCallVqmSummaries": {
1880                     "adjacencyName": "somestring",
1881                     "endpointDescription": "Caller",
1882                     "endpointJitter": 1,
1883                     "endpointRtpOctetsDiscarded": 1,
1884                     "endpointRtpOctetsReceived": 1,
1885                     "endpointRtpOctetsSent": 1,
1886                     "endpointRtpPacketsDiscarded": 1,
1887                     "endpointRtpPacketsReceived": 1,
1888                     "endpointRtpPacketsSent": 1,
1889                     "localJitter": 1,
1890                     "localRtpOctetsDiscarded": 1,
1891                     "localRtpOctetsReceived": 1,
1892                     "localRtpOctetsSent": 1,
1893                     "localRtpPacketsDiscarded": 1,
1894                     "localRtpPacketsReceived": 1,
1895                     "localRtpPacketsSent": 1,
1896                     "mosCqe": 1,
1897                     "packetLossPercent": 1,
1898                     "packetsLost": 1,
1899                     "rFactor": 1,
1900                     "roundTripDelay": 1
1901                 },
1902                 "midCallRtcp": "somestring",
1903                 "phoneNumber": "somestring",
1904                 "vendorVnfNameFields": {
1905                     "vendorName": "somestring",
1906                     "vfModuleName": "somestring",
1907                     "vnfName": "somestring"
1908                 },
1909                 "voiceQualityFieldsVersion": 1
1910             }
1911         }
1912     }
1913
1914 Responses
1915 +++++++++
1916
1917 **200**
1918 ^^^^^^^
1919
1920 VES Event Accepted.
1921
1922
1923 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1924
1925 **Example:**
1926
1927 .. code-block:: javascript
1928
1929     {
1930         "code": 1,
1931         "message": "somestring",
1932         "type": "somestring"
1933     }
1934
1935 **400**
1936 ^^^^^^^
1937
1938 Bad request provided
1939
1940
1941 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1942
1943 **Example:**
1944
1945 .. code-block:: javascript
1946
1947     {
1948         "code": 1,
1949         "message": "somestring",
1950         "type": "somestring"
1951     }
1952
1953 **401**
1954 ^^^^^^^
1955
1956 Unauthorized request
1957
1958
1959 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1960
1961 **Example:**
1962
1963 .. code-block:: javascript
1964
1965     {
1966         "code": 1,
1967         "message": "somestring",
1968         "type": "somestring"
1969     }
1970
1971 **503**
1972 ^^^^^^^
1973
1974 Service Unavailable
1975
1976
1977 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1978
1979 **Example:**
1980
1981 .. code-block:: javascript
1982
1983     {
1984         "code": 1,
1985         "message": "somestring",
1986         "type": "somestring"
1987     }
1988
1989
1990
1991 Security
1992 ++++++++
1993
1994 .. csv-table::
1995     :header: "Security Schema", "Scopes"
1996     :widths: 15, 45
1997
1998         :ref:`basicAuth <securities_basicAuth>`, ""
1999
2000 Data Structures
2001 ~~~~~~~~~~~~~~~
2002
2003
2004 ApiResponseMessage Model Structure
2005 ----------------------------------
2006
2007 .. csv-table::
2008     :delim: |
2009     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2010     :widths: 20, 10, 15, 15, 30, 25
2011
2012         code | No | integer | int32 |  |
2013         message | No | string |  |  |
2014         type | No | string |  |  |
2015
2016
2017 VES5Request Model Structure
2018 ---------------------------
2019
2020 .. csv-table::
2021     :delim: |
2022     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2023     :widths: 20, 10, 15, 15, 30, 25
2024
2025         event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` |  |  |
2026
2027 .. _d_df249c51a416f54e5609f2ffffe059c0:
2028
2029 codecsInUse Model Structure
2030 ---------------------------
2031
2032 number of times an identified codec was used over the measurementInterval
2033
2034 .. csv-table::
2035     :delim: |
2036     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2037     :widths: 20, 10, 15, 15, 30, 25
2038
2039         codecIdentifier | Yes | string |  |  |
2040         numberInUse | Yes | integer |  |  |
2041
2042 .. _d_a68e1b21fdcef792db73f711201c56ad:
2043
2044 commonEventHeader Model Structure
2045 ---------------------------------
2046
2047 fields common to all events
2048
2049 .. csv-table::
2050     :delim: |
2051     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2052     :widths: 20, 10, 15, 15, 30, 25
2053
2054         domain | Yes | string |  | {'enum': ['fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality']} | the eventing domain associated with the event
2055         eventId | Yes | string |  |  | event key that is unique to the event source
2056         eventName | Yes | string |  |  | unique event name
2057         eventType | No | string |  |  | for example - applicationVnf, guestOS, hostOS, platform
2058         internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` |  |  |
2059         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
2060         nfNamingCode | No | string |  |  | 4 character network function type, aligned with vnf naming standards
2061         nfcNamingCode | No | string |  |  | 3 character network function component type, aligned with vfc naming standards
2062         priority | Yes | string |  | {'enum': ['High', 'Medium', 'Normal', 'Low']} | processing priority
2063         reportingEntityId | No | string |  |  | UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process
2064         reportingEntityName | Yes | string |  |  | name of the entity reporting the event, for example, an EMS name; may be the same as sourceName
2065         sequence | Yes | integer |  |  | ordering of events communicated by an event source instance or 0 if not needed
2066         sourceId | No | string |  |  | UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process
2067         sourceName | Yes | string |  |  | name of the entity experiencing the event issue
2068         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
2069         version | Yes | number |  |  | version of the event header
2070
2071 .. _d_6e043350cba5faafe21de49c2f6fd745:
2072
2073 counter Model Structure
2074 -----------------------
2075
2076 performance counter
2077
2078 .. csv-table::
2079     :delim: |
2080     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2081     :widths: 20, 10, 15, 15, 30, 25
2082
2083         criticality | Yes | string |  | {'enum': ['CRIT', 'MAJ']} |
2084         name | Yes | string |  |  |
2085         thresholdCrossed | Yes | string |  |  |
2086         value | Yes | string |  |  |
2087
2088 .. _d_6f081937f31c09078c8acf9212d6c449:
2089
2090 cpuUsage Model Structure
2091 ------------------------
2092
2093 usage of an identified CPU
2094
2095 .. csv-table::
2096     :delim: |
2097     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2098     :widths: 20, 10, 15, 15, 30, 25
2099
2100         cpuIdentifier | Yes | string |  |  | cpu identifer
2101         cpuIdle | No | number |  |  | percentage of CPU time spent in the idle task
2102         cpuUsageInterrupt | No | number |  |  | percentage of time spent servicing interrupts
2103         cpuUsageNice | No | number |  |  | percentage of time spent running user space processes that have been niced
2104         cpuUsageSoftIrq | No | number |  |  | percentage of time spent handling soft irq interrupts
2105         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
2106         cpuUsageSystem | No | number |  |  | percentage of time spent on system tasks running the kernel
2107         cpuUsageUser | No | number |  |  | percentage of time spent running un-niced user space processes
2108         cpuWait | No | number |  |  | percentage of CPU time spent waiting for I/O operations to complete
2109         percentUsage | Yes | number |  |  | aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running
2110
2111 .. _d_bb7a69764c21219953df76826934938e:
2112
2113 diskUsage Model Structure
2114 -------------------------
2115
2116 usage of an identified disk
2117
2118 .. csv-table::
2119     :delim: |
2120     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2121     :widths: 20, 10, 15, 15, 30, 25
2122
2123         diskIdentifier | Yes | string |  |  | disk identifier
2124         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
2125         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
2126         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
2127         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
2128         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
2129         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
2130         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
2131         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
2132         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
2133         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
2134         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
2135         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
2136         diskOctetsReadAvg | No | number |  |  | number of octets per second read from a disk or partition; provide the average measurement within the measurement interval
2137         diskOctetsReadLast | No | number |  |  | number of octets per second read from a disk or partition; provide the last measurement within the measurement interval
2138         diskOctetsReadMax | No | number |  |  | number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval
2139         diskOctetsReadMin | No | number |  |  | number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval
2140         diskOctetsWriteAvg | No | number |  |  | number of octets per second written to a disk or partition; provide the average measurement within the measurement interval
2141         diskOctetsWriteLast | No | number |  |  | number of octets per second written to a disk or partition; provide the last measurement within the measurement interval
2142         diskOctetsWriteMax | No | number |  |  | number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval
2143         diskOctetsWriteMin | No | number |  |  | number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval
2144         diskOpsReadAvg | No | number |  |  | number of read operations per second issued to the disk; provide the average measurement within the measurement interval
2145         diskOpsReadLast | No | number |  |  | number of read operations per second issued to the disk; provide the last measurement within the measurement interval
2146         diskOpsReadMax | No | number |  |  | number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval
2147         diskOpsReadMin | No | number |  |  | number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval
2148         diskOpsWriteAvg | No | number |  |  | number of write operations per second issued to the disk; provide the average measurement within the measurement interval
2149         diskOpsWriteLast | No | number |  |  | number of write operations per second issued to the disk; provide the last measurement within the measurement interval
2150         diskOpsWriteMax | No | number |  |  | number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval
2151         diskOpsWriteMin | No | number |  |  | number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval
2152         diskPendingOperationsAvg | No | number |  |  | queue size of pending I/O operations per second; provide the average measurement within the measurement interval
2153         diskPendingOperationsLast | No | number |  |  | queue size of pending I/O operations per second; provide the last measurement within the measurement interval
2154         diskPendingOperationsMax | No | number |  |  | queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval
2155         diskPendingOperationsMin | No | number |  |  | queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval
2156         diskTimeReadAvg | No | number |  |  | milliseconds a read operation took to complete; provide the average measurement within the measurement interval
2157         diskTimeReadLast | No | number |  |  | milliseconds a read operation took to complete; provide the last measurement within the measurement interval
2158         diskTimeReadMax | No | number |  |  | milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval
2159         diskTimeReadMin | No | number |  |  | milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval
2160         diskTimeWriteAvg | No | number |  |  | milliseconds a write operation took to complete; provide the average measurement within the measurement interval
2161         diskTimeWriteLast | No | number |  |  | milliseconds a write operation took to complete; provide the last measurement within the measurement interval
2162         diskTimeWriteMax | No | number |  |  | milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval
2163         diskTimeWriteMin | No | number |  |  | milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval
2164
2165 .. _d_c911a0a8abdb511d7cd6590f383d817b:
2166
2167 endOfCallVqmSummaries Model Structure
2168 -------------------------------------
2169
2170 provides end of call voice quality metrics
2171
2172 .. csv-table::
2173     :delim: |
2174     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2175     :widths: 20, 10, 15, 15, 30, 25
2176
2177         adjacencyName | Yes | string |  |  |  adjacency name
2178         endpointDescription | Yes | string |  | {'enum': ['Caller', 'Callee']} | Either Caller or Callee
2179         endpointJitter | No | number |  |  |
2180         endpointRtpOctetsDiscarded | No | number |  |  |
2181         endpointRtpOctetsReceived | No | number |  |  |
2182         endpointRtpOctetsSent | No | number |  |  |
2183         endpointRtpPacketsDiscarded | No | number |  |  |
2184         endpointRtpPacketsReceived | No | number |  |  |
2185         endpointRtpPacketsSent | No | number |  |  |
2186         localJitter | No | number |  |  |
2187         localRtpOctetsDiscarded | No | number |  |  |
2188         localRtpOctetsReceived | No | number |  |  |
2189         localRtpOctetsSent | No | number |  |  |
2190         localRtpPacketsDiscarded | No | number |  |  |
2191         localRtpPacketsReceived | No | number |  |  |
2192         localRtpPacketsSent | No | number |  |  |
2193         mosCqe | No | number |  |  | 1-5 1dp
2194         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)
2195         packetsLost | No | number |  |  |
2196         rFactor | No | number |  |  | 0-100
2197         roundTripDelay | No | number |  |  | millisecs
2198
2199 .. _d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb:
2200
2201 event Model Structure
2202 ---------------------
2203
2204 the root level of the common event format
2205
2206 .. csv-table::
2207     :delim: |
2208     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2209     :widths: 20, 10, 15, 15, 30, 25
2210
2211         commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` |  |  |
2212         faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` |  |  |
2213         heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` |  |  |
2214         measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` |  |  |
2215         mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` |  |  |
2216         otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` |  |  |
2217         sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` |  |  |
2218         stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` |  |  |
2219         syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` |  |  |
2220         thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` |  |  |
2221         voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` |  |  |
2222
2223 .. _d_4089a4a9ee684770c6f37a588a577589:
2224
2225 eventDomainThrottleSpecification Model Structure
2226 ------------------------------------------------
2227
2228 specification of what information to suppress within an event domain
2229
2230 .. csv-table::
2231     :delim: |
2232     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2233     :widths: 20, 10, 15, 15, 30, 25
2234
2235         eventDomain | Yes | string |  |  | Event domain enum from the commonEventHeader domain field
2236         suppressedFieldNames | No | array of string |  |  | List of optional field names in the event block that should not be sent to the Event Listener
2237         suppressedNvPairsList | No | array of :ref:`suppressedNvPairs <d_52877eda2d273b282063857f97fa7ff4>` |  |  | Optional list of specific NvPairsNames to suppress within a given Name-Value Field
2238
2239 .. _d_e7aa5254472f7823fdd6d5a090bfd0a4:
2240
2241 faultFields Model Structure
2242 ---------------------------
2243
2244 fields specific to fault events
2245
2246 .. csv-table::
2247     :delim: |
2248     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2249     :widths: 20, 10, 15, 15, 30, 25
2250
2251         alarmAdditionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | additional alarm information
2252         alarmCondition | Yes | string |  |  | alarm condition reported by the device
2253         alarmInterfaceA | No | string |  |  | card, port, channel or interface name of the device generating the alarm
2254         eventCategory | No | string |  |  | Event category, for example: license, link, routing, security, signaling
2255         eventSeverity | Yes | string |  | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity
2256         eventSourceType | Yes | string |  |  | type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction
2257         faultFieldsVersion | Yes | number |  |  | version of the faultFields block
2258         specificProblem | Yes | string |  |  | short description of the alarm or problem
2259         vfStatus | Yes | string |  | {'enum': ['Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting termination']} | virtual function status enumeration
2260
2261 .. _d_76d7f35861442236cee9f716ea1e1540:
2262
2263 featuresInUse Model Structure
2264 -----------------------------
2265
2266 number of times an identified feature was used over the measurementInterval
2267
2268 .. csv-table::
2269     :delim: |
2270     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2271     :widths: 20, 10, 15, 15, 30, 25
2272
2273         featureIdentifier | Yes | string |  |  |
2274         featureUtilization | Yes | integer |  |  |
2275
2276 .. _d_a9799335edbbc52c7f0c5191f7bd09ee:
2277
2278 field Model Structure
2279 ---------------------
2280
2281 name value pair
2282
2283 .. csv-table::
2284     :delim: |
2285     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2286     :widths: 20, 10, 15, 15, 30, 25
2287
2288         name | Yes | string |  |  |
2289         value | Yes | string |  |  |
2290
2291 .. _d_18e1fa5fd6774deefce826b075f8b6e7:
2292
2293 filesystemUsage Model Structure
2294 -------------------------------
2295
2296 disk usage of an identified virtual machine in gigabytes and/or gigabytes per second
2297
2298 .. csv-table::
2299     :delim: |
2300     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2301     :widths: 20, 10, 15, 15, 30, 25
2302
2303         blockConfigured | Yes | number |  |  |
2304         blockIops | Yes | number |  |  |
2305         blockUsed | Yes | number |  |  |
2306         ephemeralConfigured | Yes | number |  |  |
2307         ephemeralIops | Yes | number |  |  |
2308         ephemeralUsed | Yes | number |  |  |
2309         filesystemName | Yes | string |  |  |
2310
2311 .. _d_bb1527d221e848e0896c78552979238b:
2312
2313 gtpPerFlowMetrics Model Structure
2314 ---------------------------------
2315
2316 Mobility GTP Protocol per flow metrics
2317
2318 .. csv-table::
2319     :delim: |
2320     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2321     :widths: 20, 10, 15, 15, 30, 25
2322
2323         avgBitErrorRate | Yes | number |  |  | average bit error rate
2324         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
2325         avgPacketLatency | Yes | number |  |  | average delivery latency
2326         avgReceiveThroughput | Yes | number |  |  | average receive throughput
2327         avgTransmitThroughput | Yes | number |  |  | average transmit throughput
2328         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
2329         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
2330         flowActivatedBy | No | string |  |  | Endpoint activating the flow
2331         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
2332         flowActivationMicrosec | Yes | number |  |  | Integer microseconds for the start of the flow connection
2333         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
2334         flowDeactivatedBy | No | string |  |  | Endpoint deactivating the flow
2335         flowDeactivationEpoch | Yes | number |  |  | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time
2336         flowDeactivationMicrosec | Yes | number |  |  | Integer microseconds for the start of the flow connection
2337         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
2338         flowStatus | Yes | string |  |  | connection status at reporting time as a working / inactive / failed indicator value
2339         gtpConnectionStatus | No | string |  |  | Current connection state at reporting time
2340         gtpTunnelStatus | No | string |  |  | Current tunnel state  at reporting time
2341         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
2342         ipTosList | No | array of string |  |  | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255'
2343         largePacketRtt | No | number |  |  | large packet round trip time
2344         largePacketThreshold | No | number |  |  | large packet threshold being applied
2345         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
2346         maxReceiveBitRate | No | number |  |  | maximum receive bit rate
2347         maxTransmitBitRate | No | number |  |  | maximum transmit bit rate
2348         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
2349         mobileQciCosList | No | array of string |  |  | Array of unique LTE QCI or UMTS class-of-service values observed in the flow
2350         numActivationFailures | Yes | number |  |  | Number of failed activation requests, as observed by the reporting node
2351         numBitErrors | Yes | number |  |  | number of errored bits
2352         numBytesReceived | Yes | number |  |  | number of bytes received, including retransmissions
2353         numBytesTransmitted | Yes | number |  |  | number of bytes transmitted, including retransmissions
2354         numDroppedPackets | Yes | number |  |  | number of received packets dropped due to errors per virtual interface
2355         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
2356         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
2357         numHttpErrors | No | number |  |  | Http error count
2358         numL7BytesReceived | Yes | number |  |  | number of tunneled layer 7 bytes received, including retransmissions
2359         numL7BytesTransmitted | Yes | number |  |  | number of tunneled layer 7 bytes transmitted, excluding retransmissions
2360         numLostPackets | Yes | number |  |  | number of lost packets
2361         numOutOfOrderPackets | Yes | number |  |  | number of out-of-order packets
2362         numPacketErrors | Yes | number |  |  | number of errored packets
2363         numPacketsReceivedExclRetrans | Yes | number |  |  | number of packets received, excluding retransmission
2364         numPacketsReceivedInclRetrans | Yes | number |  |  | number of packets received, including retransmission
2365         numPacketsTransmittedInclRetrans | Yes | number |  |  | number of packets transmitted, including retransmissions
2366         numRetries | Yes | number |  |  | number of packet retries
2367         numTimeouts | Yes | number |  |  | number of packet timeouts
2368         numTunneledL7BytesReceived | Yes | number |  |  | number of tunneled layer 7 bytes received, excluding retransmissions
2369         roundTripTime | Yes | number |  |  | round trip time
2370         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
2371         tcpFlagList | No | array of string |  |  | Array of unique TCP Flags observed in the flow
2372         timeToFirstByte | Yes | number |  |  | Time in milliseconds between the connection activation and first byte received
2373
2374 .. _d_6ea626e11ce7887cddd39c36ff4f0926:
2375
2376 heartbeatFields Model Structure
2377 -------------------------------
2378
2379 optional field block for fields specific to heartbeat events
2380
2381 .. csv-table::
2382     :delim: |
2383     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2384     :widths: 20, 10, 15, 15, 30, 25
2385
2386         additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | additional heartbeat fields if needed
2387         heartbeatFieldsVersion | Yes | number |  |  | version of the heartbeatFields block
2388         heartbeatInterval | Yes | integer |  |  | current heartbeat interval in seconds
2389
2390 .. _d_2873d30f54c59ef635c1fc0cbbaa89f1:
2391
2392 internalHeaderFields Model Structure
2393 ------------------------------------
2394
2395 enrichment fields for internal VES Event Listener service use only, not supplied by event sources
2396
2397
2398
2399 .. _d_d8868aee802ae8e2b1e7ea1c4ecc1f54:
2400
2401 jsonObject Model Structure
2402 --------------------------
2403
2404 json object schema, name and other meta-information along with one or more object instances
2405
2406 .. csv-table::
2407     :delim: |
2408     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2409     :widths: 20, 10, 15, 15, 30, 25
2410
2411         nfSubscribedObjectName | No | string |  |  | name of the object associated with the nfSubscriptonId
2412         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
2413         objectInstances | Yes | array of :ref:`jsonObjectInstance <d_7bccbee07bd3044bd0b929cb6b567c03>` |  |  | one or more instances of the jsonObject
2414         objectName | Yes | string |  |  | name of the JSON Object
2415         objectSchema | No | string |  |  | json schema for the object
2416         objectSchemaUrl | No | string |  |  | Url to the json schema for the object
2417
2418 .. _d_7bccbee07bd3044bd0b929cb6b567c03:
2419
2420 jsonObjectInstance Model Structure
2421 ----------------------------------
2422
2423 meta-information about an instance of a jsonObject along with the actual object instance
2424
2425 .. csv-table::
2426     :delim: |
2427     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2428     :widths: 20, 10, 15, 15, 30, 25
2429
2430         objectInstance | Yes | :ref:`objectInstance <i_4cf8290bf745cd386f0a55ec865aafd5>` |  |  | an instance conforming to the jsonObject schema
2431         objectInstanceEpochMicrosec | No | number |  |  | the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds
2432         objectKeys | No | array of :ref:`key <d_a217491e9c44487ec7bbd9ce3ac9dddb>` |  |  | an ordered set of keys that identifies this particular instance of jsonObject
2433
2434 .. _i_4cf8290bf745cd386f0a55ec865aafd5:
2435
2436 **Objectinstance schema:**
2437
2438
2439 an instance conforming to the jsonObject schema
2440
2441
2442
2443 .. _d_a217491e9c44487ec7bbd9ce3ac9dddb:
2444
2445 key Model Structure
2446 -------------------
2447
2448 tuple which provides the name of a key along with its value and relative order
2449
2450 .. csv-table::
2451     :delim: |
2452     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2453     :widths: 20, 10, 15, 15, 30, 25
2454
2455         keyName | Yes | string |  |  | name of the key
2456         keyOrder | No | integer |  |  | relative sequence or order of the key with respect to other keys
2457         keyValue | No | string |  |  | value of the key
2458
2459 .. _d_dc21244021b6cb0e0af16166e4600d99:
2460
2461 latencyBucketMeasure Model Structure
2462 ------------------------------------
2463
2464 number of counts falling within a defined latency bucket
2465
2466 .. csv-table::
2467     :delim: |
2468     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2469     :widths: 20, 10, 15, 15, 30, 25
2470
2471         countsInTheBucket | Yes | number |  |  |
2472         highEndOfLatencyBucket | No | number |  |  |
2473         lowEndOfLatencyBucket | No | number |  |  |
2474
2475 .. _d_669cf98e276c9992abd27056c432bbb2:
2476
2477 measurementsForVfScalingFields Model Structure
2478 ----------------------------------------------
2479
2480 measurementsForVfScaling fields
2481
2482 .. csv-table::
2483     :delim: |
2484     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2485     :widths: 20, 10, 15, 15, 30, 25
2486
2487         additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | additional name-value-pair fields
2488         additionalMeasurements | No | array of :ref:`namedArrayOfFields <d_38de3331d60414da3eea18e8f7e0ecf9>` |  |  | array of named name-value-pair arrays
2489         additionalObjects | No | array of :ref:`jsonObject <d_d8868aee802ae8e2b1e7ea1c4ecc1f54>` |  |  | array of JSON objects described by name, schema and other meta-information
2490         codecUsageArray | No | array of :ref:`codecsInUse <d_df249c51a416f54e5609f2ffffe059c0>` |  |  | array of codecs in use
2491         concurrentSessions | No | integer |  |  | peak concurrent sessions for the VM or VNF over the measurementInterval
2492         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
2493         cpuUsageArray | No | array of :ref:`cpuUsage <d_6f081937f31c09078c8acf9212d6c449>` |  |  | usage of an array of CPUs
2494         diskUsageArray | No | array of :ref:`diskUsage <d_bb7a69764c21219953df76826934938e>` |  |  | usage of an array of disks
2495         featureUsageArray | No | array of :ref:`featuresInUse <d_76d7f35861442236cee9f716ea1e1540>` |  |  | array of features in use
2496         filesystemUsageArray | No | array of :ref:`filesystemUsage <d_18e1fa5fd6774deefce826b075f8b6e7>` |  |  | filesystem usage of the VM on which the VNFC reporting the event is running
2497         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
2498         meanRequestLatency | No | number |  |  | mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running
2499         measurementInterval | Yes | number |  |  | interval over which measurements are being reported in seconds
2500         measurementsForVfScalingVersion | Yes | number |  |  | version of the measurementsForVfScaling block
2501         memoryUsageArray | No | array of :ref:`memoryUsage <d_7a758ee807f435a8ba5568e6da6ed597>` |  |  | memory usage of an array of VMs
2502         numberOfMediaPortsInUse | No | integer |  |  | number of media ports in use
2503         requestRate | No | number |  |  | peak rate of service requests per second to the VNF over the measurementInterval
2504         vNicPerformanceArray | No | array of :ref:`vNicPerformance <d_b845a2955da4c78bef3ba4d50021a240>` |  |  | usage of an array of virtual network interface cards
2505         vnfcScalingMetric | No | integer |  |  | represents busy-ness of the VNF from 0 to 100 as reported by the VNFC
2506
2507 .. _d_7a758ee807f435a8ba5568e6da6ed597:
2508
2509 memoryUsage Model Structure
2510 ---------------------------
2511
2512 memory usage of an identified virtual machine
2513
2514 .. csv-table::
2515     :delim: |
2516     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2517     :widths: 20, 10, 15, 15, 30, 25
2518
2519         memoryBuffered | No | number |  |  | kibibytes of temporary storage for raw disk blocks
2520         memoryCached | No | number |  |  | kibibytes of memory used for cache
2521         memoryConfigured | No | number |  |  | kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running
2522         memoryFree | Yes | number |  |  | kibibytes of physical RAM left unused by the system
2523         memorySlabRecl | No | number |  |  | the part of the slab that can be reclaimed such as caches measured in kibibytes
2524         memorySlabUnrecl | No | number |  |  | the part of the slab that cannot be reclaimed even when lacking memory measured in kibibytes
2525         memoryUsed | Yes | number |  |  | total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes
2526         vmIdentifier | Yes | string |  |  | virtual machine identifier associated with the memory metrics
2527
2528 .. _d_dc18fe1d28fe3ef664c3f4ab777d8424:
2529
2530 mobileFlowFields Model Structure
2531 --------------------------------
2532
2533 mobileFlow fields
2534
2535 .. csv-table::
2536     :delim: |
2537     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2538     :widths: 20, 10, 15, 15, 30, 25
2539
2540         additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | additional mobileFlow fields if needed
2541         appProtocolType | No | string |  |  | application protocol
2542         appProtocolVersion | No | string |  |  | application protocol version
2543         applicationType | No | string |  |  | Application type inferred
2544         cid | No | string |  |  | cell id
2545         connectionType | No | string |  |  | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc
2546         ecgi | No | string |  |  | Evolved Cell Global Id
2547         flowDirection | Yes | string |  |  | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow
2548         gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` |  |  |
2549         gtpProtocolType | No | string |  |  | GTP protocol
2550         gtpVersion | No | string |  |  | GTP protocol version
2551         httpHeader | No | string |  |  | HTTP request header, if the flow connects to a node referenced by HTTP
2552         imei | No | string |  |  | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device
2553         imsi | No | string |  |  | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device
2554         ipProtocolType | Yes | string |  |  | IP protocol type e.g., TCP, UDP, RTP...
2555         ipVersion | Yes | string |  |  | IP protocol version e.g., IPv4, IPv6
2556         lac | No | string |  |  | location area code
2557         mcc | No | string |  |  | mobile country code
2558         mnc | No | string |  |  | mobile network code
2559         mobileFlowFieldsVersion | Yes | number |  |  | version of the mobileFlowFields block
2560         msisdn | No | string |  |  | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device
2561         otherEndpointIpAddress | Yes | string |  |  | IP address for the other endpoint, as used for the flow being reported on
2562         otherEndpointPort | Yes | integer |  |  | IP Port for the reporting entity, as used for the flow being reported on
2563         otherFunctionalRole | No | string |  |  | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...
2564         rac | No | string |  |  | routing area code
2565         radioAccessTechnology | No | string |  |  | Radio Access Technology e.g., 2G, 3G, LTE
2566         reportingEndpointIpAddr | Yes | string |  |  | IP address for the reporting entity, as used for the flow being reported on
2567         reportingEndpointPort | Yes | integer |  |  | IP port for the reporting entity, as used for the flow being reported on
2568         sac | No | string |  |  | service area code
2569         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
2570         tac | No | string |  |  | transport area code
2571         tunnelId | No | string |  |  | tunnel identifier
2572         vlanId | No | string |  |  | VLAN identifier used by this flow
2573
2574 .. _d_38de3331d60414da3eea18e8f7e0ecf9:
2575
2576 namedArrayOfFields Model Structure
2577 ----------------------------------
2578
2579 an array of name value pairs along with a name for the array
2580
2581 .. csv-table::
2582     :delim: |
2583     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2584     :widths: 20, 10, 15, 15, 30, 25
2585
2586         arrayOfFields | Yes | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | array of name value pairs
2587         name | Yes | string |  |  |
2588
2589 .. _d_5a79cd7ce784d60fd832d9c7c0a24322:
2590
2591 otherFields Model Structure
2592 ---------------------------
2593
2594 fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration
2595
2596 .. csv-table::
2597     :delim: |
2598     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2599     :widths: 20, 10, 15, 15, 30, 25
2600
2601         hashOfNameValuePairArrays | No | array of :ref:`namedArrayOfFields <d_38de3331d60414da3eea18e8f7e0ecf9>` |  |  | array of named name-value-pair arrays
2602         jsonObjects | No | array of :ref:`jsonObject <d_d8868aee802ae8e2b1e7ea1c4ecc1f54>` |  |  | array of JSON objects described by name, schema and other meta-information
2603         nameValuePairs | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | array of name-value pairs
2604         otherFieldsVersion | Yes | number |  |  | version of the otherFields block
2605
2606 .. _d_6747334473cf2b305fe43b61a40656e1:
2607
2608 requestError Model Structure
2609 ----------------------------
2610
2611 standard request error data structure
2612
2613 .. csv-table::
2614     :delim: |
2615     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2616     :widths: 20, 10, 15, 15, 30, 25
2617
2618         messageId | Yes | string |  |  | Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception
2619         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
2620         url | No | string |  |  | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents
2621         variables | No | string |  |  | List of zero or more strings that represent the contents of the variables used by the message text
2622
2623 .. _d_c3e191f0b26ddd68f927ac0c8b551c5e:
2624
2625 sipSignalingFields Model Structure
2626 ----------------------------------
2627
2628 sip signaling fields
2629
2630 .. csv-table::
2631     :delim: |
2632     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2633     :widths: 20, 10, 15, 15, 30, 25
2634
2635         additionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | additional sip signaling fields if needed
2636         compressedSip | No | string |  |  | the full SIP request/response including headers and bodies
2637         correlator | Yes | string |  |  | this is the same for all events on this call
2638         localIpAddress | Yes | string |  |  | IP address on VNF
2639         localPort | Yes | string |  |  | port on VNF
2640         remoteIpAddress | Yes | string |  |  | IP address of peer endpoint
2641         remotePort | Yes | string |  |  | port of peer endpoint
2642         sipSignalingFieldsVersion | Yes | number |  |  | version of the sipSignalingFields block
2643         summarySip | No | string |  |  | the SIP Method or Response (INVITE, 200 OK, BYE, etc)
2644         vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` |  |  |
2645
2646 .. _d_c5450f1a263d0a2b0c64c96119f7d759:
2647
2648 stateChangeFields Model Structure
2649 ---------------------------------
2650
2651 stateChange fields
2652
2653 .. csv-table::
2654     :delim: |
2655     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2656     :widths: 20, 10, 15, 15, 30, 25
2657
2658         additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | additional stateChange fields if needed
2659         newState | Yes | string |  | {'enum': ['inService', 'maintenance', 'outOfService']} | new state of the entity
2660         oldState | Yes | string |  | {'enum': ['inService', 'maintenance', 'outOfService']} | previous state of the entity
2661         stateChangeFieldsVersion | Yes | number |  |  | version of the stateChangeFields block
2662         stateInterface | Yes | string |  |  | card or port name of the entity that changed state
2663
2664 .. _d_52877eda2d273b282063857f97fa7ff4:
2665
2666 suppressedNvPairs Model Structure
2667 ---------------------------------
2668
2669 List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling
2670
2671 .. csv-table::
2672     :delim: |
2673     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2674     :widths: 20, 10, 15, 15, 30, 25
2675
2676         nvPairFieldName | Yes | string |  |  | Name of the field within which are the nvpair names to suppress
2677         suppressedNvPairNames | Yes | array of string |  |  | Array of nvpair names to suppress within the nvpairFieldName
2678
2679 .. _d_782271970af04a3b0e5a5da9b30996d2:
2680
2681 syslogFields Model Structure
2682 ----------------------------
2683
2684 sysLog fields
2685
2686 .. csv-table::
2687     :delim: |
2688     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2689     :widths: 20, 10, 15, 15, 30, 25
2690
2691         additionalFields | No | string |  |  | additional syslog fields if needed provided as name=value
2692         eventSourceHost | No | string |  |  | hostname of the device
2693         eventSourceType | Yes | string |  |  | type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction
2694         syslogFacility | No | integer |  |  | numeric code from 0 to 23 for facility--see table in documentation
2695         syslogFieldsVersion | Yes | number |  |  | version of the syslogFields block
2696         syslogMsg | Yes | string |  |  | syslog message
2697         syslogPri | No | integer |  |  | 0-192 combined severity and facility
2698         syslogProc | No | string |  |  | identifies the application that originated the message
2699         syslogProcId | No | number |  |  | a change in the value of this field indicates a discontinuity in syslog reporting
2700         syslogSData | No | string |  |  | syslog structured data consisting of a structured data Id followed by a set of key value pairs
2701         syslogSdId | No | string |  |  | 0-32 char in format name@number for example ourSDID@32473
2702         syslogSev | No | string |  | {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} | numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8
2703         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
2704         syslogVer | No | number |  |  | IANA assigned version of the syslog protocol specification - typically 1
2705
2706 .. _d_bd95ac8a5536a5bb5e6a0de7e64b9f20:
2707
2708 thresholdCrossingAlertFields Model Structure
2709 --------------------------------------------
2710
2711 fields specific to threshold crossing alert events
2712
2713 .. csv-table::
2714     :delim: |
2715     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2716     :widths: 20, 10, 15, 15, 30, 25
2717
2718         additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | additional threshold crossing alert fields if needed
2719         additionalParameters | Yes | array of :ref:`counter <d_6e043350cba5faafe21de49c2f6fd745>` |  |  | performance counters
2720         alertAction | Yes | string |  | {'enum': ['CLEAR', 'CONT', 'SET']} | Event action
2721         alertDescription | Yes | string |  |  | Unique short alert description such as IF-SHUB-ERRDROP
2722         alertType | Yes | string |  | {'enum': ['CARD-ANOMALY', 'ELEMENT-ANOMALY', 'INTERFACE-ANOMALY', 'SERVICE-ANOMALY']} | Event type
2723         alertValue | No | string |  |  | Calculated API value (if applicable)
2724         associatedAlertIdList | No | array of string |  |  | List of eventIds associated with the event being reported
2725         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
2726         dataCollector | No | string |  |  | Specific performance collector instance used
2727         elementType | No | string |  |  | type of network element - internal ATT field
2728         eventSeverity | Yes | string |  | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity or priority
2729         eventStartTimestamp | Yes | string |  |  | Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800
2730         interfaceName | No | string |  |  | Physical or logical port or card (if applicable)
2731         networkService | No | string |  |  | network name - internal ATT field
2732         possibleRootCause | No | string |  |  | Reserved for future use
2733         thresholdCrossingFieldsVersion | Yes | number |  |  | version of the thresholdCrossingAlertFields block
2734
2735 .. _d_b845a2955da4c78bef3ba4d50021a240:
2736
2737 vNicPerformance Model Structure
2738 -------------------------------
2739
2740 describes the performance and errors of an identified virtual network interface card
2741
2742 .. csv-table::
2743     :delim: |
2744     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2745     :widths: 20, 10, 15, 15, 30, 25
2746
2747         receivedBroadcastPacketsAccumulated | No | number |  |  | Cumulative count of broadcast packets received as read at the end of the measurement interval
2748         receivedBroadcastPacketsDelta | No | number |  |  | Count of broadcast packets received within the measurement interval
2749         receivedDiscardedPacketsAccumulated | No | number |  |  | Cumulative count of discarded packets received as read at the end of the measurement interval
2750         receivedDiscardedPacketsDelta | No | number |  |  | Count of discarded packets received within the measurement interval
2751         receivedErrorPacketsAccumulated | No | number |  |  | Cumulative count of error packets received as read at the end of the measurement interval
2752         receivedErrorPacketsDelta | No | number |  |  | Count of error packets received within the measurement interval
2753         receivedMulticastPacketsAccumulated | No | number |  |  | Cumulative count of multicast packets received as read at the end of the measurement interval
2754         receivedMulticastPacketsDelta | No | number |  |  | Count of multicast packets received within the measurement interval
2755         receivedOctetsAccumulated | No | number |  |  | Cumulative count of octets received as read at the end of the measurement interval
2756         receivedOctetsDelta | No | number |  |  | Count of octets received within the measurement interval
2757         receivedTotalPacketsAccumulated | No | number |  |  | Cumulative count of all packets received as read at the end of the measurement interval
2758         receivedTotalPacketsDelta | No | number |  |  | Count of all packets received within the measurement interval
2759         receivedUnicastPacketsAccumulated | No | number |  |  | Cumulative count of unicast packets received as read at the end of the measurement interval
2760         receivedUnicastPacketsDelta | No | number |  |  | Count of unicast packets received within the measurement interval
2761         transmittedBroadcastPacketsAccumulated | No | number |  |  | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval
2762         transmittedBroadcastPacketsDelta | No | number |  |  | Count of broadcast packets transmitted within the measurement interval
2763         transmittedDiscardedPacketsAccumulated | No | number |  |  | Cumulative count of discarded packets transmitted as read at the end of the measurement interval
2764         transmittedDiscardedPacketsDelta | No | number |  |  | Count of discarded packets transmitted within the measurement interval
2765         transmittedErrorPacketsAccumulated | No | number |  |  | Cumulative count of error packets transmitted as read at the end of the measurement interval
2766         transmittedErrorPacketsDelta | No | number |  |  | Count of error packets transmitted within the measurement interval
2767         transmittedMulticastPacketsAccumulated | No | number |  |  | Cumulative count of multicast packets transmitted as read at the end of the measurement interval
2768         transmittedMulticastPacketsDelta | No | number |  |  | Count of multicast packets transmitted within the measurement interval
2769         transmittedOctetsAccumulated | No | number |  |  | Cumulative count of octets transmitted as read at the end of the measurement interval
2770         transmittedOctetsDelta | No | number |  |  | Count of octets transmitted within the measurement interval
2771         transmittedTotalPacketsAccumulated | No | number |  |  | Cumulative count of all packets transmitted as read at the end of the measurement interval
2772         transmittedTotalPacketsDelta | No | number |  |  | Count of all packets transmitted within the measurement interval
2773         transmittedUnicastPacketsAccumulated | No | number |  |  | Cumulative count of unicast packets transmitted as read at the end of the measurement interval
2774         transmittedUnicastPacketsDelta | No | number |  |  | Count of unicast packets transmitted within the measurement interval
2775         vNicIdentifier | Yes | string |  |  | vNic identification
2776         valuesAreSuspect | Yes | string |  | {'enum': ['true', 'false']} | Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions
2777
2778 .. _d_d694eebbbc0078612d2ba22e0cbf814c:
2779
2780 vendorVnfNameFields Model Structure
2781 -----------------------------------
2782
2783 provides vendor, vnf and vfModule identifying information
2784
2785 .. csv-table::
2786     :delim: |
2787     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2788     :widths: 20, 10, 15, 15, 30, 25
2789
2790         vendorName | Yes | string |  |  | VNF vendor name
2791         vfModuleName | No | string |  |  | ASDC vfModuleName for the vfModule generating the event
2792         vnfName | No | string |  |  | ASDC modelName for the VNF generating the event
2793
2794 .. _d_9551641bd1c775d9fcf4e45353de8e43:
2795
2796 voiceQualityFields Model Structure
2797 ----------------------------------
2798
2799 provides statistics related to customer facing voice products
2800
2801 .. csv-table::
2802     :delim: |
2803     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2804     :widths: 20, 10, 15, 15, 30, 25
2805
2806         additionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` |  |  | additional voice quality fields if needed
2807         calleeSideCodec | Yes | string |  |  | callee codec for the call
2808         callerSideCodec | Yes | string |  |  | caller codec for the call
2809         correlator | Yes | string |  |  | this is the same for all events on this call
2810         endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` |  |  |
2811         midCallRtcp | Yes | string |  |  | Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers
2812         phoneNumber | No | string |  |  | phone number associated with the correlator
2813         vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` |  |  |
2814         voiceQualityFieldsVersion | Yes | number |  |  | version of the voiceQualityFields block
2815