From 0c2c5b7b08e5565beab7d49d592a12d279c0816b Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Sat, 3 Jun 2023 17:36:43 +0000
Subject: [PATCH] Update README.md
---
README.md | 36 ++++++++++++++++++++++++++----------
1 file changed, 26 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index a51aeb9..ab18330 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,9 @@
-# OSPFv3 [(Download the MKP package)](/../../../-/raw/master/ospfv3.mkp "Download MKP package")
-
- **Note: this package is for CheckMK version 2.x. For other versions see the corresponding branch.**
+# OSPFv3
Monitors status of OSPFv3 enabled devices
**Note**: on Cisco devices (IOS/IOS-XE) this checks will only work with default VRF and one OSPFv3 process.\
-Also there can be onle one address family in the OSPFv3 process. Anything else nedds SNMPv3 contexts.
+Also there can be only one address family in the OSPFv3 process. Anything else nedds SNMPv3 contexts.
**Note: see the [Wiki](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/ospfv3/-/wikis/home) for a sample IOS OSPFv3 configuration**
@@ -15,12 +13,26 @@ Collection of OSPFv3 checks
* *ospfv3_interface*: monitors OSPFv3 enabled interfaces
* *ospfv3_neighbor*: monitors OSPFv3 neighbors (IPv6 only)
* *ospfv3_virtuallink*: monitors OSPFv3 virtual links (IPv6 only)
+
---
+### Download
+
+* [ospfv3.mkp (latest version)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/ospfv3/-/raw/master/ospfv3.mkp "Download latest version")
+
+---
+### Installation
+
+You can install the package by uploading it to your CheckMK site and as site user run `mkp install ospfv3.mkp`.
+
+
+In the Enterprise/Free edition 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")
+
---
-## Check Info *ospfv3_general*:
+### Check Info *ospfv3_general*
* *service*: this check creates the service *OSPFv3*
* *state*: **warning** if the OSPFv3 process is admin disabled (*shutdown*)
@@ -34,7 +46,8 @@ Sample output
-## Check Info *ospfv3_area*:
+---
+### Check Info *ospfv3_area*
* *service*: this check creates one service per OSPFv3 area
* *state*: is always ok
@@ -50,7 +63,8 @@ Sample output
-## Check Info *ospfv3_interface*:
+---
+### Check Info *ospfv3_interface*
* *service*: this check creates one service per OSPFv3 enabled interface
* *state*:
@@ -66,7 +80,8 @@ Sample output
-## Check Info *ospfv3_neighbor*:
+---
+### Check Info *ospfv3_neighbor*
* *service*: this check creates one service for each OSPFv3 neighbor
* *state*:
@@ -81,7 +96,8 @@ Sample output
-## Check Info *ospfv3_virtuallink*:
+---
+### Check Info *ospfv3_virtuallink*
* *state*:
* **warning** if the OSPFv3 virtual link state in *attempt*, *init*, *exchangeStart*, *exchange* or *loading*
--
GitLab