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 3.27 KiB
Newer Older
thl-cmk's avatar
thl-cmk committed
[PACKAGE]: ../../raw/master/mkp/check_radius-0.1.1-20240428.mkp "check_radius-0.1.1-20240428.mkp"
thl-cmk's avatar
thl-cmk committed
[PYRADLIB]: ../../raw/master/mkp/pyrad-2.4.0-240421.mkp "pyrad-2.4.0-240421.mkp"
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
This is a (very) basic active RADIUS check. Tests if a RADIUS server is responsive (accept/reject/timeout). There is (limited) support to add AV-pairs to the RADIUS request.
thl-cmk's avatar
thl-cmk committed

---
### Download
* [Download latest mkp file][PACKAGE]
thl-cmk's avatar
thl-cmk committed
* [pyrad-2.4.0-240421.mkp][PYRADLIB] The pyrad lib as MKP (contains pyrad 2.4, six 1.16.0, netaddr 1.2.1).
thl-cmk's avatar
thl-cmk committed

**Note**: before you update to a newer version, always check the [CHANGELOG](CHANGELOG). There migth be incompatible changes.
                        
---
### Installation

You can install the package by uploading it to your CheckMK site and as site user run 
```
mkp add PAKAGE_NAME.mkp
mkp enable PAKAGE_NAME VERSION
```

In the Enterprise/Free/Cloud edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_)

thl-cmk's avatar
thl-cmk committed
**Note**: before you can use this plugin you need to install the python lib [**_pyrad_**](https://github.com/pyradius/pyrad) into your CMK site. This can be done by issuing the command `pip3 install pyrad` as site user, as long as your CMK server has internet access. If you prefer not to download the pyrad lib from the internet you can also use the additional MKP package **_pyrad-2.4.0-240421.mkp_** (see above).

thl-cmk's avatar
thl-cmk committed
---
### Want to Contribute?

Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")

---
### Check Info

thl-cmk's avatar
thl-cmk committed
The plugin creates the service **_RADIUS_** with an optional item.
thl-cmk's avatar
thl-cmk committed

<details><summary>Montoring states</summary>

| State | condition | WATO | 
| ------ | ------ | ------ |
thl-cmk's avatar
thl-cmk committed
| WARN/CRIT | wrong response code | yes |
| WARN/CRIT | respos time above levels | yes |
| CRIT | Network error | no |
| CRIT | RADIUS request timeout | no |
| WARN/CRIT | wrong # of response attributes | yes |
thl-cmk's avatar
thl-cmk committed

</details>

<details><summary>Perfdata</summary>

| Metric | Unit | Perfometer |
| ------ | ------ | ------ |
thl-cmk's avatar
thl-cmk committed
| response timne | s | yes |
thl-cmk's avatar
thl-cmk committed

</details>

---
### WATO
thl-cmk's avatar
thl-cmk committed
<details><summary>Active check rule</summary>
thl-cmk's avatar
thl-cmk committed

| Section | Rule name |
| ------ | ------ |
thl-cmk's avatar
thl-cmk committed
| HTTP, TCP, Email, ... | RADIUS service |

| Option | Defailt value | Comment |
| ------ | ------ | --- |
| Service description | none | the optional item |
| Server IP-address or name | none | optional |
| Authentication port | 1812 | |
| Shared secret | none | |
thl-cmk's avatar
thl-cmk committed
| Request timeout | 1 second | |
thl-cmk's avatar
thl-cmk committed
| User name | dummyuser | |
| User password | dummypassword | |
| Request Attributes | none | List of optional AV-pairs for the request |
| Expected response | none | Accept/Reject |
| Monitoring state not expected response | Warn | |
| Max. response time | none | Upper levels max. response time in ms |
| # of expected attribues in response | none | |
| Monitoring state on wrong # of response attributes | Warn |  |
thl-cmk's avatar
thl-cmk committed

</details> 

thl-cmk's avatar
thl-cmk committed
<details><summary>Supported Request Attributes</summary>

- Called-Station-Id
- Calling-Station-Id
thl-cmk's avatar
thl-cmk committed
- Cisco-AVPair
thl-cmk's avatar
thl-cmk committed
- Framed-MTU
- NAS-IP-Address
thl-cmk's avatar
thl-cmk committed
- NAS-Identifier
- NAS-Port
thl-cmk's avatar
thl-cmk committed
- NAS-Port-Id
- NAS-Port-Type
- Service-Type

</details>

thl-cmk's avatar
thl-cmk committed
---
### Sample Output

Sample output

![sample output](/img/sample.png?raw=true "sample output")

Sample output details

![sample output details](/img/sample-details.png?raw=true "sample output details")