Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com

Skip to content
README.md 4.19 KiB
Newer Older
thl-cmk's avatar
thl-cmk committed
# Cisco Cellular LTE
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
This package contains the two plugins _cisco_cellular_lte_ and _inv_cisco_cellular_lte_.\
There is a WATO rule for the check plugin and for the discovery. The are both called _Cisco cellular LTE_.

 <details><summary>cisco_cellular_lte</summary>

thl-cmk's avatar
thl-cmk committed
This check plugin will discover all cellular interfaces. If they have a connection associated it will show
thl-cmk's avatar
thl-cmk committed

-    the connection status
-    the values for RSSI, RSRP and RSRQ
thl-cmk's avatar
thl-cmk committed
-    the Bandwith used in/out
thl-cmk's avatar
thl-cmk committed
-    the band used


and in the deails
thl-cmk's avatar
thl-cmk committed
-    the associated IP-Addresses (IPv4 and IPv6)
-    the roaming state
thl-cmk's avatar
thl-cmk committed
-    the current channel
-    the network code
-    the service typoe
-    the provider time
-    modem state and status
-    the APN
-    the configured and the current APN type

</details>
<details><summary>inv_cisco_cellular_lte</summary>

thl-cmk's avatar
thl-cmk committed
This inventory plugin adds under _Networking_ -> _Cellular (LTE)_:
thl-cmk's avatar
thl-cmk committed

-    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)
thl-cmk's avatar
thl-cmk committed
-    the Network code
thl-cmk's avatar
thl-cmk committed
-    the APN (Access Point Nam)
-    the Service type
-    the current band

With the inventory view _Search Cellular (LTE)_ you can filter and report on this data for all your hosts.
</details>
thl-cmk's avatar
thl-cmk committed

---
thl-cmk's avatar
thl-cmk committed
### Download
thl-cmk's avatar
thl-cmk committed
* [cisco_cellular_lte.mkp](https://thl-cmk.hopto.org/gitlab/checkmk/cisco/cisco_cellular_lte/-/raw/master/cisco_cellular_lte.mkp "Download the MKP file")
thl-cmk's avatar
thl-cmk committed
                        
thl-cmk's avatar
thl-cmk committed
---
### Installation
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
You can install the package by uploading it to your CheckMK site and as site user run `mkp install cisco_cellular_lte.mkp`.
thl-cmk's avatar
thl-cmk committed


thl-cmk's avatar
thl-cmk committed
In the Enterprise/Free edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_)

---
### Want to Contribute?
thl-cmk's avatar
thl-cmk committed
Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")

thl-cmk's avatar
thl-cmk committed
---
### WATO
thl-cmk's avatar
thl-cmk committed
<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 |

thl-cmk's avatar
thl-cmk committed
</details> 

thl-cmk's avatar
thl-cmk committed
<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 |
thl-cmk's avatar
thl-cmk committed

</details> 

thl-cmk's avatar
thl-cmk committed
<details><summary>HW/SW inventory rules</summary>
thl-cmk's avatar
thl-cmk committed
The inventory plugin is not configurable.
</details> 

thl-cmk's avatar
thl-cmk committed
---
thl-cmk's avatar
thl-cmk committed
### Check Info

thl-cmk's avatar
thl-cmk committed
The plugin creates the service **_Cellular_** for each cellular interface with the **_cellular_interface_name_** as item
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
<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>
thl-cmk's avatar
thl-cmk committed


---
### Sample Output and WATO

Sample output

![sample output](/doc/sample.jpg?raw=true "sample output")

Sample output details

![sample output details](/doc/sample-details.jpg?raw=true "sample output details")
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
WATO
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
![WATO options](/doc/wato.png?raw=true "WATO options")