diff --git a/README.md b/README.md index 5070457da55e10084a1b1254b386e12588dbff16..ee013ae2a8c5aed31bbcddd6a5877dee4d8a4f95 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,8 @@ [PACKAGE]: ../../raw/master/snmp_state-0.0.3-20230802.mkp "snmp_state-0.0.3-20230802.mkp" -# Title +# SNMP State -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 plugin is intended to help you keep track of the SNMP configuration CheckMK is using to monitor your hosts. +It will generate alerts for old/bad SNMP configurations. Via WATO you can configure what old/bad means for you. --- ### Download @@ -20,8 +13,8 @@ if there are more than on plugin put it in collapsable sections You can install the package by uploading it to your CheckMK site and as site user run ``` -mkp install PAKAGE_NAME.mkp -mkp enable PAKAGE_NAME VERSION +mkp install snmp_state-0.0.3-20230802.mkp +mkp enable snmp_state 0.0.3-20230802 ``` In the Enterprise/Free/Cloud edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) @@ -34,7 +27,7 @@ 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 **_SNMP State_** for each host with SNMP enabled <details><summary>Montoring states</summary> @@ -48,11 +41,7 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi <details><summary>Perfdata</summary> -| Metric | Unit | Perfometer | -| ------ | ------ | ------ | -| METRIC 1 | bit/s | yes | -| METRIC 2 | C | yes | -| METRIC 3 | V | no | +There are no perf data. </details> @@ -62,31 +51,29 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi | 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 | +| Networking | SNMP State | | Option | Defailt value | | ------ | ------ | -| OPTION 1 | disabled | +| excepted SNMP Versions | Version 3 | +| Monitoring state if version not in excepted versions | Warning | +| excepted SNMP v3 level | authentication and privacy | +| Monitoring state if level is not in excepted list | Warning | +| excepted SNMP v3 authentication | SHA, SHA-224, SHA-256, SHA-384, SHA-512 | +| Monitoring state if authentication is not in excepted list | Warning | +| excepted SNMP v3 encryption | AES-128 | +| Monitoring state if SNMP v3 encryption is not in excepted list | Warning | +| excepted SNMP backend| Inline, Classic | +| Monitoring state if backend not in excepted backends | Warning | +| minimal key length | 10 | +| Monitoring state if key length below minimal key length | Warning | +| Monitoring state when authentication and encryption key are identical | Warning | +| List of default keys | public, private | +| Monitoring state if key used is a default key | Warning | +| Key complexity excepted characters in the key | Digit, Lowercase, Uppercase, Special | +| Monitoring state if key complexity not met | Warning | -</details> -<details><summary>HW/SW inventory rules</summary> -The inventory plugin is not configurable. </details> ---