X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fuser-guide.rst;h=0acb6235a617180f9b2cd331c61bf8a3ae267a88;hb=43fe17ef30078c8ceb624a4aa5167d509466e086;hp=2d5b63330af4982f5c90868b00c9caf5df784eb4;hpb=835e399ad9a1d705f58fb96c7d69f1021bc31d15;p=ric-plt%2Falarm-go.git

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 2d5b633..0acb623 100755
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -147,13 +147,21 @@ CLI commands can have some of the following parameters
  --atx         Alarm text string, example string: E2 CONNECTIVITY LOST TO E-NODEB
  --ety         Event type string, example string: Communication error
  --oin         Operation instructions string, example string: Not defined
+ --rad         Raise alarm delay in seconds. Default value = 0
+ --cad         Clear alarm delay in seconds. Default value = 0
  --prf         Performance profile id, possible values: 1 = peak performance test or 2 = endurance test
  --nal         Number of alarms, example value: 50
  --aps         Alarms per second, example value: 1
  --tim         Total time of test in minutes, example value: 1 
- --host        Alarm Manager REST address: default value = localhost
- --port        Alarm Manager REST port: default value = 8080
+ --host        Alarm Manager host address. Default value = localhost
+ --port        Alarm Manager port. Default value = 8080
  --if          Used Alarm Manager command interface, http or rmr: default value = http
+ --active      Active alerts in Prometheus Alert Manager. Default value = true
+ --inhibited   Inhibited alerts in Prometheus Alert Manager. Default value = true
+ --silenced    Silenced alerts in Prometheus Alert Manager. Default value = true
+ --unprocessed Unprocessed alerts in Prometheus Alert Manager. Default value = true
+ --host        Prometheus Alert Manager host address
+ --port        Prometheus Alert Manager port. Default value = 9093
 
 
 ``Note that there are two minus signs before parameter name!``
@@ -220,11 +228,11 @@ CLI command examples:
 
  .. code-block:: none
 
-  Syntax: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined" [--host] [--port]
+  Syntax: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined" [--rad] [--cad] [--host] [--port]
 
-  Example: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined"
+  Example: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined" --rad 0 --cad 0
 
-  Example: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined" --host localhost --port 8080
+  Example: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined" --rad 0 --cad 0 --host localhost --port 8080
 
  Delete existing alarm definition:
 
@@ -261,6 +269,14 @@ CLI command examples:
 
   Endurance test example: cli/alarm-cli perf --prf 2 --nal 50 --aps 1 --tim 1 --host localhost --port 8080 --if rmr
 
+Get alerts from Prometheus Alert Manager: 
+
+ .. code-block:: none
+
+  Syntax: cli/alarm-cli alerts --active --inhibited --silenced --unprocessed --host [--port]
+
+  Example: cli/alarm-cli alerts --active true --inhibited true --silenced true --unprocessed true --host 10.102.36.121 --port 9093
+
 
 REST interface usage guide
 --------------------------
@@ -305,11 +321,11 @@ Below are examples for REST interface. Curl tool is used to send REST commands.
 
  Add one new alarm definition:
 
-   Example: curl -X POST "http://localhost:8080/ric/v1/alarms/define" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"alarmdefinitions\": [{\"alarmId\": 8007, \"alarmText\": \"E2 CONNECTIVITY LOST TO E-NODEB\", \"eventtype\": \"Communication error\", \"operationinstructions\": \"Not defined\"}]}"
+   Example: curl -X POST "http://localhost:8080/ric/v1/alarms/define" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"alarmdefinitions\": [{\"alarmId\": 8007, \"alarmText\": \"E2 CONNECTIVITY LOST TO E-NODEB\", \"eventtype\": \"Communication error\", \"operationinstructions\": \"Not defined\, \"raiseDelay\": 1, \"clearDelay\": 1"}]}"
 
  Add two new alarm definitions:
 
-   Example: curl -X POST "http://localhost:8080/ric/v1/alarms/define" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"alarmdefinitions\": [{\"alarmId\": 8007, \"alarmText\": \"E2 CONNECTIVITY LOST TO E-NODEB\", \"eventtype\": \"Communication error\", \"operationinstructions\": \"Not defined\"},{\"alarmId\": 8008, \"alarmText\": \"ACTIVE ALARM EXCEED MAX THRESHOLD\", \"eventtype\": \"storage warning\", \"operationinstructions\": \"Clear alarms or raise threshold\"}]}"
+   Example: curl -X POST "http://localhost:8080/ric/v1/alarms/define" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"alarmdefinitions\": [{\"alarmId\": 8007, \"alarmText\": \"E2 CONNECTIVITY LOST TO E-NODEB\", \"eventtype\": \"Communication error\", \"operationinstructions\": \"Not defined\, \"raiseDelay\": 0, \"clearDelay\": 0"},{\"alarmId\": 8008, \"alarmText\": \"ACTIVE ALARM EXCEED MAX THRESHOLD\", \"eventtype\": \"storage warning\", \"operationinstructions\": \"Clear alarms or raise threshold\", \"raiseDelay\": 0, \"clearDelay\": 0}]}"
 
  Delete one existing alarm definition: