diff options
Diffstat (limited to 'pnfsimulator/README.md')
| -rw-r--r-- | pnfsimulator/README.md | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/pnfsimulator/README.md b/pnfsimulator/README.md index 9f7e996..844fdf5 100644 --- a/pnfsimulator/README.md +++ b/pnfsimulator/README.md @@ -56,7 +56,12 @@ Sample Request: Enables direct, immediate event sending without need to have template deployed on backend. Keywords are supported,thus once passed, will also be substituted with proper strings. Passed event body must be valid and complete event according to VES Collector interface. -To trigger sending use following endpoint *http://<simulator_ip>:5000/simulator/event*. +To trigger sending use following endpoint *http://<simulator_ip>:5000/simulator/event*. +After sending event, response message from VES will be passed as response message from Simulator. +Thanks to that when sending one-time event user will receive information about request. +This is helpful when authentication fail or VES response with "Forbidden" when using http instead of https. +In a situation when given URL address is not pointing to VES, Simulator response with status ```421``` +and information about communication problem. Supported method: *POST* Headers: @@ -108,7 +113,7 @@ The simulator provides means for managing templates. Supported actions: adding, ```GET /template/list``` Lists all templates known to the simulator. -```GET /template/get-content/{name}``` +```GET /template/get/{name}``` Gets template content based on *name* path variable. ```POST /template/upload?override=true``` @@ -370,8 +375,14 @@ CA certificates are incorporated into simulator docker image, thus no additional Certificates can be found in docker container under path: */usr/local/share/ca-certificates/* -Simulator works with VES that uses both self-signed certificate (already present in keystore) and VES integrated to AAF. - +Simulator works with VES that uses both self-signed certificate (already present in keystore) and VES integrated to AAF. + +Certification loading can be disabled by setting environment variable ```USE_CERTIFICATE_FOR_AUTHORIZATION``` to false. +Once certificate are not used for authorization, user can set up VES url using username and password. + + { + "vesServerUrl": "http://<user>:<password>@<ves_url>:<port>/eventListener/v7" + } ## Developers Guide |