diff --git a/README.md b/README.md index f9f3aa9fdb09fae30071358a9dba97e14994cf56..7a1435aab57599f47b0ba10b56ba0a34516f2dfe 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ -# Cisco Cellular LTE +# Cisco 2G/3G/4G wireless connection This package contains the two plugins. The check plugin **_cisco_cellular_lte_** and the inventory plugin **_inv_cisco_cellular_lte_**. <details><summary>cisco_cellular_lte</summary> -This check plugin will discover all cellular interfaces and monitor the status of the cellular connection (2G/3G/4G).\ -If they have a connection associated it will show +This check plugin will monitor 2G/3G/4G wireless connections. By default it will only discover cellular interfaces with a SIM card attached. It will show - the connection status - the values for RSSI, RSRP and RSRQ - the Bandwith used in/out -- the band used +- the wireless band used and in the deails @@ -57,6 +56,39 @@ In the Enterprise/Free edition of CheckMK you can use the GUI to install the pac ### Want to Contribute? Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing") +--- +### Check Info + +The plugin creates the service **_Cellular_** for each discovered cellular interface with the **_cellular_interface_name_** as item + +<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> + --- ### WATO <details><summary>Service monitoring rule</summary> @@ -89,7 +121,7 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut | Option | Defailt value | | ------ | ------ | -| do not Discover interfaces without associated SIM card | disabled | +| Discover interfaces without associated SIM card | disabled | </details> @@ -98,41 +130,7 @@ The inventory plugin is not configurable. </details> --- -### Check Info - -The plugin creates the service **_Cellular_** for each cellular interface with the **_cellular_interface_name_** as item - -<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> - - ---- -### Sample Output and WATO +### Sample Output Sample output @@ -142,6 +140,3 @@ Sample output details  -WATO - -