1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2022 Nordix
5 .. |nbsp| unicode:: 0xA0
8 .. |nbh| unicode:: 0x2011
18 The O-RAN SC external server is an extension for Near-RealTime RIC simulator. It creates an external web server building RESTful API. It is capable of recieving Rest calls from the northbound simulator version STD_2.0.0 and responses back to it.
20 The details of API definitions are being explained below:
22 .. Generates content from EXT_SRV_api.yaml
23 .. openapi:: ../near-rt-ric-simulator/test/EXT_SRV/api/EXT_SRV_api.yaml
35 Returns the status of the external server.
51 curl -X GET "http://localhost:9095/"
60 Delete all policy instances in external server
61 ----------------------------------------------
66 Delete all policy instances.
70 /serveradmin/deleteinstances
80 All a1 policy instances deleted
86 curl -X POST "http://localhost:9095/serveradmin/deleteinstances"
92 All a1 policy instances deleted
97 It is possible to manipulate the response of all operations on the external server
102 Force a specific response code for the all (the next) external server operation. Unless it is reset, it will always respond the same response code back.
106 /serveradmin/forceresponse?code=<http-response-code>
112 The HTTP response code to return.
118 Force response code: <expected code> set for all external server response until it is resetted
124 curl -X POST "http://localhost:9095/serveradmin/forceresponse?code=500"
130 Force response code: 500 set for all external server response until it is resetted
133 Reset response-manipulation
134 ---------------------------
135 It is possible to reset the response manipulation on the external server
140 Clears specific response code for all (the next) external server operation.
144 /serveradmin/forceresponse?code=<http-response-code>
150 The HTTP response code to return.
156 Force response code has been resetted for all external server responses
162 curl -X POST "http://localhost:9095/serveradmin/forceresponse?code=500"
168 Force response code has been resetted for all external server responses
171 Response time manipulation
172 --------------------------
173 It is possible to set a period of time to delay response time.
178 Force delayed response of all A1 responses. The setting will remain until the delay is set to '0'
182 /serveradmin/forcedelay?delay=<delay-time-seconds>
188 The time in seconds to delay all responses.
194 Force delay: <expected_delay> sec set for all external server responses until it is resetted
200 curl -X POST "http://localhost:9095/serveradmin/forcedelay?delay=5"
206 Force delay: 5 sec set for all external server responses until it is resetted
209 Reset response time manipulation
210 --------------------------------
211 It is also possible to reset delay response time.
216 The setting will clear the delay.
220 /serveradmin/forcedelay
226 The time in seconds to delay all responses.
232 Force delay has been resetted for all external server responses
238 curl -X POST "http://localhost:9095/serveradmin/forcedelay"
244 Force delay has been resetted for all external server responses