diff --git a/README.md b/README.md index 5df5a6cf1ce01141f41739cf01874af56329d461..a2f6b2d84c0ed04ebe1ff7149e6019766762b958 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,7 @@ [PACKAGE]: ../../raw/master/mkp/check_radius-0.0.1-20240421.mkp "check_radius-0.0.1-20240421.mkp" -# Title +# Check RADIUS -A short description about the plugin - -if there are more than on plugin put it in collapsable sections -<details><summary>check_plugin_1</summary> - -</details> -<details><summary>check_pluhin_2</summary> - -</details> +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. --- ### Download @@ -36,15 +28,17 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut --- ### Check Info -The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT with the **_HOW_TO_BUILD_THE_ITEM_** as item +The plugin creates the service **_RADIUS server_** with an optional item. <details><summary>Montoring states</summary> | State | condition | WATO | | ------ | ------ | ------ | -| WARN | condition 1 | yes | -| CRIT | condition 2 | no | -| WARN/CRIT | condition 3 | no | +| 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 | </details> @@ -52,43 +46,34 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi | Metric | Unit | Perfometer | | ------ | ------ | ------ | -| METRIC 1 | bit/s | yes | -| METRIC 2 | C | yes | -| METRIC 3 | V | no | +| response timne | s | yes | </details> --- ### WATO -<details><summary>Service monitoring rule</summary> +<details><summary>Active check rule</summary> | Section | Rule name | | ------ | ------ | -| Networking | NAME_OF_THE_RULE | - -| Option | Defailt value | -| ------ | ------ | -| OPTION 1 | 10/50| -| OPTION 2 | 70/90 | -| OPTION 3 | CHOICE 1 | -| OPTION 4 | disabled | - -</details> - -<details><summary>Discovery rule</summary> - -| Section | Rule name | -| ------ | ------ | -| Discovery of individual services | NAME_OF_THE_RULE | - -| Option | Defailt value | -| ------ | ------ | -| OPTION 1 | disabled | - -</details> +| 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 | | +| Request timeout | 1 secunde | | +| 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 | | -<details><summary>HW/SW inventory rules</summary> -The inventory plugin is not configurable. </details> ---