From ed98542ef5054c2c0a4626e4cda6945b4b146946 Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Sat, 1 Oct 2022 10:33:55 +0000
Subject: [PATCH] Update README.md

---
 README.md | 102 ++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 64 insertions(+), 38 deletions(-)

diff --git a/README.md b/README.md
index 554b226..d556c4c 100644
--- a/README.md
+++ b/README.md
@@ -5,17 +5,17 @@ There is a WATO rule for the check plugin and for the discovery. The are both ca
 
  <details><summary>cisco_cellular_lte</summary>
 
-This check plugin will discover all cellular interfaces. If the have a 2G/3G/4G connection attached it will show
+This check plugin will discover all cellular interfaces. If they have a connection associated it will show
 
 -    the connection status
--    the roaming state
 -    the values for RSSI, RSRP and RSRQ
--    the bits/s in/out
+-    the Bandwith used in/out
 -    the band used
--    the IP-Address associated with this connection
 
 
 and in the deails
+-    the associated IP-Addresses (IPv4 and IPv6)
+-    the roaming state
 -    the current channel
 -    the network code
 -    the service typoe
@@ -27,13 +27,13 @@ and in the deails
 </details>
 <details><summary>inv_cisco_cellular_lte</summary>
 
-This inventory plugin adds under _Networking_ -> _Cellular_ (LTE) the following:
+This inventory plugin adds under _Networking_ -> _Cellular (LTE)_:
 
 -    the IMEI (International Mobile Equipment Identifier)
 -    the IMSI (International Mobile Subscriber Identifier)
 -    the ICC ID (Integrated Circuit Card ID)
 -    the MSISDN (Mobile Subscriber Integrated Services Digital Network Number)
--    the Network
+-    the Network code
 -    the APN (Access Point Nam)
 -    the Service type
 -    the current band
@@ -59,51 +59,77 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut
 
 ---
 ### WATO
-<details><summary>check plugin</summary>
-
-Rulename: Cisco cellular LTE\
-Options
--   Lower levels for RSRP: default -100dBm/-115dBm
--   Lower levels for RSRQ: default -8dB/-15dB
--   Lower levels for RSSI: default -75 dBm/-85dBm
--   Monitoring state if the device is roaming: default WARN
--   Monitoring state if no GSM/LTE profile configured: default WARN
--   Monitoring state if the device is not connected: default WARN
--   Monitoring state if the modem is not up: default WARN
--   Monitoring state if the modem is not online: default WARN
+<details><summary>Service monitoring rule</summary>
+
+| Section | Rule name |
+| ------ | ------ |
+| Networking | Cisco cellular LTE  |
+
+| Option | Defailt value |
+| ------ | ------ |
+| Lower levels for RSRP | -100dBm/-115dBm |
+| Lower levels for RSRQ | -8dB/-15dB |
+| Lower levels for RSSI | -75 dBm/-85dBm |
+| Expected Band | LTE Band |
+| Monitoring state if current band is not expected band | WARN |
+| Monitoring state if the device is roaming | WARN |
+| Monitoring state if no SIM card associated | WARN |
+| Monitoring state if the device is not connected | WARN |
+| Monitoring state if the modem is not up | WARN |
+| Monitoring state if the modem is not online | WARN |
+| the device is not affected by Cisco Bug ID CSCvt55347 | disabled |
+
 </details> 
 
-<details><summary>discovery</summary>
+<details><summary>Discovery rule</summary>
+
+| Section | Rule name |
+| ------ | ------ |
+| Discovery of individual services | Cisco cellular LTE  |
+
+| Option | Defailt value |
+| ------ | ------ |
+| do not Discover interfaces without associated SIM card | disabled |
 
-Rulename: Cisco cellular LTE\
-Options
--   Discover not configured interfaces: default disabled
 </details> 
 
-<details><summary>inventory plugin</summary>
+<details><summary>HW/SW inventory rules</summary>
 The inventory plugin is not configurable.
 </details> 
 
 ---
 ### Check Info
 
-* *service*: creates the service **_Cellular_** for each cellular interface with the cellular_interface_name as item
+The plugin creates the service **_Cellular_** for each cellular interface with the **_cellular_interface_name_** as item
 
----
-* *state*:
-    * **warning**: 
-        * if no GSM/LTE profile is configured
-        * if 
+<details><summary>Montoring states</summary>
+
+| State | condition | WATO | 
+| ------ | ------ | ------ |
+| WARN | no SIM card attached to the interface | yes |
+| CRIT | connection state not active | yes |
+| CRIT | modem state not up | yes |
+| CRIT | modem not online | yes |
+| WARN | connection is roaming | yes |
+| WARN/CRIT | RSSI is below -75dBm/-85dBm | yes |
+| WARN/CRIT | RSRP is below -100dBm/-115dBm| yes |
+| WARN/CRIT | RSRQ is below -8dB/-15dB | yes |
+| WARN | current Band is not as expected | yes |
+
+</details>
+
+<details><summary>Perfdata</summary>
+
+| Metric | Unit | Perfometer |
+| ------ | ------ | ------ |
+| Input Bandwidth | bit/s | yes |
+| Output bandwidt | bit/s | yes |
+| RSSI | dBm | no |
+| RSRQ | dB | no |
+| RSRP | dBm | no |
+
+</details>
 
-    * **critical**/**warning**: 
-        * if
----
-* *perfdata (if avilable)*: 
-    * Offset (s)
-    * Delay (s)
-    * Jitter (s)
-    * Protocol errors (/s)
-    * Version errors (/s)
 
 ---
 ### Sample Output and WATO
-- 
GitLab