diff --git a/README.md b/README.md index 8e747f3ab7d1ba1c640b6393951124e8eb06f027..a0afdbc07958622e6eb5867f087588d302c5971c 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,9 @@ Monitors status of OSPF neighbors. +--- ### Acknowledgment -This check is originaly from Thomas Wollner (tw[at]wollner-net[dot]de). +This check is based on [OSPF Neighbor State Check](https://exchange.checkmk.com/p/ospf-neighbor) by Thomas Wollner (tw[at]wollner-net[dot]de). I changed the *item* from neighbor **ID** to neighbor **IP**, added events as perfdata (incl. metrics file),\ moved part of the output to long output and done a little code cleanup to better match coding guide lines.\ @@ -29,26 +30,35 @@ Added WATO for Alias name, map check states to OSPF Neighbor state, state if nei --- ### Download -* [ospf_neighbor.mkp](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/ospf_neighbor/-/raw/master/ospf_neighbor.mkp "Download the MKP file") - ---- -### Installation -You can install the package by uploading it to your CheckMK site and as site user run `mkp install ospf_neighbor.mkp`. +* [Download latest mkp file][PACKAGE] +**Note**: before you update to a newer version, always check the [CHANGELOG](CHANGELOG). There might be incompatible changes. -In the Enterprise/Free edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) +--- +### Installation + +You can install the package by uploading it to your CheckMK site and as site user run +``` +mkp install PACKAGENAME-VERSION.mkp +``` +or beginning with CMK2.2.x +``` +mkp add PACKAGENAME-VERSION.mkp +mkp enable PACKAGENAME VERSION +``` +In the non RAW editions of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) --- -### Want to Contribute? +### Want to contribute? + Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing") --- +### Sample output -Sample output - - + WATO options - +