1 # O-RAN Components interfacing with VES-Collector
3 Test scripts for interfacing with DCAE.
5 ONAP Honolulu DCAE VES-Collector supports the interface definition [CommonEventFormat_30.2.1_ONAP.json](https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/ves.git;a=blob;f=etc/CommonEventFormat_30.2.1_ONAP.json).
7 The ONAP VES version is described in [ONAP documentation](https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter8/ves_7_2/ves_event_listener_7_2.html?highlight=dcae%20ves%20header#).
9 VES domain 'stndDefined' offers the capability to inject external schema definitions of the VES.
10 This way the 3GPP notification syntax can be transported. Please see [SA88-Rel16 schema](https://forge.3gpp.org/rep/sa5/MnS/tree/SA88-Rel16/OpenAPI).
15 This git project must be cloned on a ubuntu machine in order to execute the bash scripts.
16 DCAE provide REST interfaces. In order to perform HTTP request [cURL](https://curl.haxx.se/) is used.
18 In case cURL needs to be please use the following command in a terminal.
24 Python3 is expected to run some scripts.
30 It is necessary to configure the DCAE servers for valid execution of the bash scripts.
31 Please update the variables in [config](-/config) accordingly to the test environment.
34 urlVes=http://localhost:8443/eventListener/v7
35 basicAuthVes=sample1:sample1
40 Several tests scripts are available in the root of this project.
41 The bash and python scripts will perform an HTTPS-POST request to a VES-Collector.
45 The syntax of a single VES event is devices into a common header and an event
48 The event specific bodies are are identified by the VES domain.
50 ### VES Domain "fault"
52 This script 'sendFault' sends a VES message of domain "fault" to DCAE. It requires three command line parameters:
54 1. **equipmentType**: Valid equipment types for 1806 and 1810 are [1234, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
56 2. **alarmType**: or alarm name. Any string which references a supported alarm name of the equipment type.
58 3. **severity**: The severity of tha alarm as defined by [VES schema](https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/ves.git;a=blob;f=etc/CommonEventFormat_30.2.1_ONAP.json).
60 The following example show the usage of this script. The alarm "lossOfSignal" for equipment type "nSky" with severity "CRITICAL" will be send.
63 ./sendFault.sh nSky lossOfSignal CRITICAL
66 ### VES Domain "heartbeat",
68 The script 'sendVesHeartbeat' simulates a VES event of domain "heartbeat" from SDN-R to DCAE VES-Collector.
70 The following example show the usage of this script:
73 python3 sendVesHeartbeat.py
76 ### VES Domain "measurement",
78 This script 'send15minPm' sends a VES message of domain "measurementsForVfScaling" to DCAE. The script requires one input parameter. This parameter defines the equipment type. Valid equipment types for 1806 and 1810 are [1234, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
84 ### VES Domain "mobileFlow",
86 Not required by O-RAN Alliance OAM specification.
88 ### VES Domain "notification",
90 The script 'sendVesNotification' simulates a VES event of domain "notification" from a network-function to DCAE VES-Collector.
92 The following example show the usage of this script:
95 python3 sendVesNotification.py --pnfId nSky
98 ### VES Domain "other",
100 Not required by O-RAN Alliance OAM specification.
102 ### VES Domain "perf3gpp",
104 Not required by O-RAN Alliance OAM specification.
106 ### VES Domain "pnfRegistration",
108 The script 'pnfRegister' creates a PNF object in A&AI. The script requires one input parameter. This parameter defines the equipment type. Valid equipment types for 1806 and 1810 are [1234, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
111 ./pnfRegister.sh 7DEV
113 ### VES Domain "sipSignaling",
115 Not required by O-RAN Alliance OAM specification.
117 ### VES Domain "stateChange",
119 The script 'sendVesStateChange' simulates a VES event of domain "stateChange" from a network-function to DCAE VES-Collector.
121 The following example show the usage of this script:
124 python3 sendVesStateChange.py --pnfId nSky
127 ### VES Domain "stndDefined",
129 The script 'sendVesStndDefined' simulates a VES event of domain "stateChange" from a network-function to DCAE VES-Collector. Four schema definitions by 3GPP are supported:
131 - 3GPP-FaultSupervision
133 - 3GPP-PerformanceAssurance
136 The following examples show the usage of this script:
139 python sendVesStndDefined.py --pnfId nSky --body 3GPP-FaultSupervision
140 python sendVesStndDefined.py --pnfId nSky --body 3GPP-Heartbeat
141 python sendVesStndDefined.py --pnfId nSky --body 3GPP-PerformanceAssurance
142 python sendVesStndDefined.py --pnfId nSky --body 3GPP-Provisioning
145 ### VES Domain "syslog",
147 Not required by O-RAN Alliance OAM specification.
149 ### VES Domain "thresholdCrossingAlert",
151 This script 'sendTca' sends a VES message of domain "thresholdCrossingAlert" to DCAE. It requires three command line parameters:
153 1. **equipmentType**: Valid equipment types for 1806 and 1810 are [1234, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
155 2. **alarmType**: or alarm name. Any string which references a supported alarm name (TCA) of the equipment type.
157 3. **alertAction**: The action of TCA as defined by [VES schema](https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/ves.git;a=blob;f=etc/CommonEventFormat_30.2.1_ONAP.json).
159 The following example show the usage of this script. The TCA with name "TCA" for equipment type "1234" with alarmAction "SET" will be send.
162 ./sendTca.sh 1234 TCA SET
165 ### VES Domain "voiceQuality"
167 Not required by O-RAN Alliance OAM specification.
169 ### Sending a VES event list
171 This script send a VES message of domain "fault" AND "heartbeat" as event list to DCAE. It requires three command line parameters:
173 1. **equipmentType**: Valid equipment types for 1806 and 1810 are [1234, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
175 2. **alarmType**: or alarm name. Any string which references a supported alarm name of the equipment type.
177 3. **severity**: The severity of tha alarm as defined by [VES schema](https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/ves.git;a=blob;f=etc/CommonEventFormat_30.2.1_ONAP.json).
179 The following example show the usage of this script. The alarm "lossOfSignal" for equipment type "nSky" with severity "CRITICAL" will be send.
182 ./sendEventList.sh 1234 lossOfSignal CRITICAL