solution/dev/ves-test-collector/client-scripts-ves-v7/READMEpy.md

   1 # VES Events
   2
   3 VES: Virtual Event Streaming (HTTP1.1/json-schema)
   4
   5 This document describes sending of VES events according to
   6 [VES 7.2.1](https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/ves.git;a=blob;f=etc/CommonEventFormat_30.2.1_ONAP.json)
   7 as expected by O-RAN Operation and Maintenance Interface Specification.
   8
   9 ## Prerequisites
  10
  11 Python3 is expected to run the scripts.
  12
  13 ```
  14 pip3 install requests
  15 ```
  16
  17 ## VES Domains
  18
  19 The syntax of a single VES event is devices into a common header and an event
  20 specific body.
  21
  22 The event specific bodies are are identified by the VES domain.
  23
  24 ### VES Domain "fault"
  25
  26 tbd.
  27
  28 ### VES Domain "heartbeat",
  29
  30 The script simulates a VES event of domain "heartbeat" from SDN-R to DCAE VES-Collector.
  31
  32 The following example show the usage of this script:
  33
  34 ```
  35 python3 sendVesHeartbeat.py
  36 ```
  37
  38 ### VES Domain "measurement",
  39
  40 tbd.
  41
  42 ### VES Domain "mobileFlow",
  43
  44 tbd.
  45
  46 ### VES Domain "notification",
  47
  48 The script simulates a VES event of domain "notification" from a physical
  49 network-function to DCAE VES-Collector.
  50
  51 The following example show the usage of this script:
  52
  53 ```
  54 python3 sendVesNotification.py --pnfId nSky
  55 ```
  56
  57 ### VES Domain "other",
  58
  59 tbd.
  60
  61 ### VES Domain "perf3gpp",
  62
  63 tbd.
  64
  65 ### VES Domain "pnfRegistration",
  66
  67 tbd.
  68
  69 ### VES Domain "sipSignaling",
  70
  71 tbd.
  72
  73 ### VES Domain "stateChange",
  74
  75 The script simulates a VES event of domain "stateChange" from a physical
  76 network-function to DCAE VES-Collector.
  77
  78 The following example show the usage of this script:
  79
  80 ```
  81 python3 sendVesStateChange.py --pnfId nSky
  82 ```
  83
  84 ### VES Domain "stndDefined",
  85
  86 tbd.
  87
  88 ### VES Domain "syslog",
  89
  90 tbd.
  91
  92 ### VES Domain "thresholdCrossingAlert",
  93
  94 tbd.
  95
  96 ### VES Domain "voiceQuality"
  97
  98 tbd.