Add test script for o1NotifyPnfRegistration 45/9345/1
authordemx8as6 <martin.skorupski@highstreet-technologies.com>
Fri, 21 Oct 2022 11:30:05 +0000 (13:30 +0200)
committerdemx8as6 <martin.skorupski@highstreet-technologies.com>
Fri, 21 Oct 2022 11:34:31 +0000 (13:34 +0200)
- update README for o1NotifyPnfRegistration support

IssueID: OAM-302
Change-Id: I0447458ad3a827399f5a3a5b64520a3a84be195f
Signed-off-by: demx8as6 <martin.skorupski@highstreet-technologies.com>
code/client-scripts-ves-v7/README.md

index 3b33358..f34cdff 100644 (file)
@@ -13,12 +13,12 @@ This way the 3GPP notification syntax can be transported. Please see [SA88-Rel16
 ## Prerequisites
 
 This git project must be cloned on a ubuntu machine in order to execute the bash scripts.
-DCAE provide REST interfaces. In order to perform HTTP request [cURL](https://curl.haxx.se/) is used. 
+DCAE provide REST interfaces. In order to perform HTTP request [cURL](https://curl.haxx.se/) is used.
 
 In case cURL needs to be please use the following command in a terminal.
 
 ```
-sudo apt install curl 
+sudo apt install curl
 ```
 
 Python3 is expected to run some scripts.
@@ -37,7 +37,7 @@ basicAuthVes=sample1:sample1
 
 ## Concept
 
-Several tests scripts are available in the root of this project. 
+Several tests scripts are available in the root of this project.
 The bash and python scripts will perform an HTTPS-POST request to a VES-Collector.
 
 ## VES Domains
@@ -51,11 +51,11 @@ The event specific bodies are are identified by the VES domain.
 
 This script 'sendFault' sends a VES message of domain "fault" to DCAE. It requires three command line parameters:
 
-1. **equipmentType**: Valid equipment types for 1806 and 1810 are [1234, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
+1. **equipmentType**: Valid equipment types for 1806 and 1810 are [pnf2, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
 
 2. **alarmType**: or alarm name. Any string which references a supported alarm name of the equipment type.
 
-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). 
+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).
 
 The following example show the usage of this script. The alarm "lossOfSignal" for equipment type "nSky" with severity "CRITICAL" will be send.
 
@@ -75,7 +75,7 @@ python3 sendVesHeartbeat.py
 
 ### VES Domain "measurement",
 
-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".
+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 [pnf2, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
 
 ```
 ./send15minPm.sh FYNG
@@ -83,7 +83,7 @@ This script 'send15minPm' sends a VES message of domain "measurementsForVfScalin
 
 ### VES Domain "mobileFlow",
 
-Not required by O-RAN Alliance OAM specification. 
+Not required by O-RAN Alliance OAM specification.
 
 ### VES Domain "notification",
 
@@ -97,22 +97,22 @@ python3 sendVesNotification.py --pnfId nSky
 
 ### VES Domain "other",
 
-Not required by O-RAN Alliance OAM specification. 
+Not required by O-RAN Alliance OAM specification.
 
 ### VES Domain "perf3gpp",
 
-Not required by O-RAN Alliance OAM specification. 
+Not required by O-RAN Alliance OAM specification.
 
 ### VES Domain "pnfRegistration",
 
-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".
+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 [pnf2, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
 
 ```
 ./pnfRegister.sh 7DEV
 ```
 ### VES Domain "sipSignaling",
 
-Not required by O-RAN Alliance OAM specification. 
+Not required by O-RAN Alliance OAM specification.
 
 ### VES Domain "stateChange",
 
@@ -144,40 +144,40 @@ python sendVesStndDefined.py --pnfId nSky --body 3GPP-Provisioning
 
 ### VES Domain "syslog",
 
-Not required by O-RAN Alliance OAM specification. 
+Not required by O-RAN Alliance OAM specification.
 
 ### VES Domain "thresholdCrossingAlert",
 
 This script 'sendTca' sends a VES message of domain "thresholdCrossingAlert" to DCAE. It requires three command line parameters:
 
-1. **equipmentType**: Valid equipment types for 1806 and 1810 are [1234, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
+1. **equipmentType**: Valid equipment types for 1806 and 1810 are [pnf2, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
 
 2. **alarmType**: or alarm name. Any string which references a supported alarm name (TCA) of the equipment type.
 
-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). 
+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).
 
-The following example show the usage of this script. The TCA with name "TCA" for equipment type "1234" with alarmAction "SET" will be send.
+The following example show the usage of this script. The TCA with name "TCA" for equipment type "pnf2" with alarmAction "SET" will be send.
 
 ```
-./sendTca.sh 1234 TCA SET
+./sendTca.sh pnf2 TCA SET
 ```
 
 ### VES Domain "voiceQuality"
 
-Not required by O-RAN Alliance OAM specification. 
+Not required by O-RAN Alliance OAM specification.
 
 ### Sending a VES event list
 
 This script send a VES message of domain "fault" AND "heartbeat" as event list to DCAE. It requires three command line parameters:
 
-1. **equipmentType**: Valid equipment types for 1806 and 1810 are [1234, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
+1. **equipmentType**: Valid equipment types for 1806 and 1810 are [pnf2, FYNG, R2D2, 7DEV, nSky, 1OSF] according to document "295672 SDN-R System Requirements".
 
 2. **alarmType**: or alarm name. Any string which references a supported alarm name of the equipment type.
 
-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). 
+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).
 
 The following example show the usage of this script. The alarm "lossOfSignal" for equipment type "nSky" with severity "CRITICAL" will be send.
 
 ```
-./sendEventList.sh 1234 lossOfSignal CRITICAL
+./sendEventList.sh pnf2 lossOfSignal CRITICAL
 ```