From c6973c740a0c09f1673e1a55fdb787f29b7ffaba Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Wed, 7 Jun 2023 18:25:56 +0000
Subject: [PATCH] Update README.md
---
README.md | 26 ++++++++++++++++++--------
1 file changed, 18 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index a6c47e8..58c84d2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# BGP Peer [(Download the MKP package)](/../../../-/raw/master/bgp_peer.mkp "Download MKP package")
+# BGP Peer
Check plugin to monitors status of BGP peers and inventory plugin for static BGP peer data.
@@ -7,36 +7,46 @@ Check plugin to monitors status of BGP peers and inventory plugin for static BGP
**NOTE**: this check is the base for the [Arista](https://thl-cmk.hopto.org/gitlab/checkmk/arista_networks/arista_bgp_peer), [Cisco](https://thl-cmk.hopto.org/gitlab/checkmk/cisco/cisco_bgp_peer), [Huawei](https://thl-cmk.hopto.org/gitlab/checkmk/huawei/huawei_bgp_peers) and [Juniper](https://thl-cmk.hopto.org/gitlab/checkmk/juniper-networks/juniper_bgp_peer) BGP peer addons.
---
-
-### Check Info:
+### Check Info
* *service*: creates the service **BGP Peer** with the ip-address of the peer as item. Depending on the addon the address family and the VRF/VR/Remote AS will also be used in the item. Except for the remote peer address this is configurable.
----
-
* *state*:\
**critical**: if Peer state is idle or if accepted_prefixes >= prefix_admin_limit\
**warning**: if Peer state is not idle or not established, if accepted_prefixes >= warn_threshold, if Admin state is not admin start\
**critical**/**warning**: if Peer uptime below the configured levels\
**critical**: if Peer not found in SNMP data
----
-
* *wato*: [see WATO options](/doc/wato.png?raw=true "WATO options")
----
* *perfdata (if avilable)*:
* in/out updates (/s)
* in/out messages (/s)
* Peer uptime (s)
* Last update recived (/s)
* FMS Transitions (count)
+
---
+### Download
+
+* [bgp_peer.mkp (latest version)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer/-/raw/master/bgp_peer.mkp "Download latest version")
+---
+### Installation
+
+You can install the package by uploading it to your CheckMK site and as site user run `mkp install bgp_peer.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?
+
Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")
---
+### Sample output
+
<details><summary>Sample output</summary>
</details>
--
GitLab