diff --git a/README.md b/README.md index 2342ef44ed201bfaf33e3feb6c2034c8be9845b6..ae7a598b9ab950fdc1d62388e4b3f319fad0e8b2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,37 @@ -# if64name [Download the MKP package](/../../../-/raw/2.0.x/if64name.mkp "Download MKP package") +[PACKAGE]: ../../raw/2.0.x/if64name.mkp "Download latest version if64name.mkp" +# if64name This extension for the _if64_ check, It will replace _ifDescr_ with _ifName_ if available.\ Also the long interface name will be replaced by a short version (ie. **HundredGigabitEthernet0/0/0** replaced by **Hu0/0/0**).\ To use this extension you need to have a interface discovery rule that uses interface description for the service item.\ To use the unchanged _if64_ version, just disable the _if64name_ snmp section. The original _if64_ check stayes completely unchanged. +--- +### Download + +* [Download latest mkp file][PACKAGE] + +**Note**: before you update to a newer version, alway 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 install PACKAGENAME-VERSION.mkp +``` +or beginning with CMK2.2.x +``` +mkp add PACKAGENAME-VERSION.mkp +mkp enable PACKAGENAME VERSION +``` +In the Enterprise/Free edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) + --- #### Want to contribute? Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing") + --- Sample output