From 21d385db944a61445dd66c3942841e92b2906029 Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Mon, 18 Apr 2022 08:51:10 +0000
Subject: [PATCH] Update README.md
---
README.md | 30 +++++++++++++++++++++---------
1 file changed, 21 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 657cb0d..7380bba 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,24 @@
-# Huawei BGP Peers
-
+# Huawei BGP Peer
Monitors status of Huawei BGP peers (HUAWEI-BGP-VPN-MIB)
-Check Info:
+**Note**: the service name has ben changed from _**Huawei BGP peer**_ to _**BGP peer**_.
+
+**Note**: This plugin is based on [BGP Peer](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer "BGP Peer"). To use **_huawei_bgp_peer_** you need to install **_bgp_peer_** as well.
+
+----
+### Download
+
+- [huawaei_bgp_peer.mkp](/../../../-/raw/master/huawaei_bgp_peer.mkp "Download MKP package")
+
+----
+### Check Info:
* *service*: this check creates one service for each peer/address family (IPv4 and IPv6)
* *state*: \
**critical**: if Peer state is idle or if *hwBgpPeerUnAvaiReason* not 0\
**warning**: if Peer state is not idle and not established, if Peer uptime < min. uptime
-* *wato*:
- * **min uptime**: minimum time before a bgp peer connection is consinderd as stable, default 86400 seconds (1 day)
- * **Infotext values**: select which information is shown in the check output
- * **BGP Peer item name**: The configured value must match a BGP peer reported by the monitored device. For example: "10.194.115.98 IPv4 Unicast"
- * **BGP Peer Alias**: You can configure an individual alias here for the BGP peer matching the text configured in the "BGP Peer item name" field. This alias will be shown in the infotext
- * **MonitoringState**: You can configure an individual state if the BGP peer matching the text configured in the "BGP Peer item name" field is not found (default is critical).
+* *wato*: [see bgp_peer WATO options](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer/-/raw/master/doc/wato.png?raw=true "BGP Peer WATO options")
+
* *perfdata*:
* FMS transitions (count)
* FMS last change (s)
@@ -21,6 +26,13 @@ Check Info:
* Prefixes received (count)
* Prefixes active (count)
+---
+
+#### Want to contribute?
+Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")
+
+---
+
Sample output
--
GitLab