From 9c61f41ba301aa942d660682a010420ef483fdf0 Mon Sep 17 00:00:00 2001 From: thl-cmk <thl-cmk@outlook.com> Date: Tue, 17 Jan 2023 20:21:39 +0000 Subject: [PATCH] Update README.md --- README.md | 53 +++++++++++++++++++++++------------------------------ 1 file changed, 23 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 9af952d..2273580 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,22 @@ # BGP peer -Monitors status of Arista Networks BGP peers (IPv4 and IPv6) +Monitors the status of Arista Networks BGP peers (IPv4 and IPv6) **Note**: this plugin will supersede the original `arista_bgp` plugin. <details><summary>arista_bgp_peer</summary> +This plugin will create one service for each BGP peer/adressfamily. It supports IPv4 and IPv6. + +**Note:** This is a snmp section only. + </details> <details><summary>inv_arista_bgp_peer</summary> +The inventory plugin collects all the static data for each BGP peer. + +**Note:** This is a snmp section only. + </details> --- @@ -18,8 +26,7 @@ Monitors status of Arista Networks BGP peers (IPv4 and IPv6) --- ### Installation -You can install the package by uploading it to your CheckMK site and as site user run `mkp install PAKAGE_NAME.mkp`. - +You can install the package by uploading it to your CheckMK site and as site user run `mkp install arista_bgp_peer.mkp`. In the Enterprise/Free edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) @@ -32,25 +39,24 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut --- ### Check Info -The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT with the **_HOW_TO_BUILD_THE_ITEM_** as item +For more information about the check plugin see the vendor independent plugin [BGP Peer](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer "BGP Peer"). <details><summary>Montoring states</summary> -| State | condition | WATO | -| ------ | ------ | ------ | -| WARN | condition 1 | yes | -| CRIT | condition 2 | no | -| WARN/CRIT | condition 3 | no | +See [BGP Peer](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer "BGP Peer") </details> <details><summary>Perfdata</summary> +See [BGP Peer](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer "BGP Peer") + +Additional perfdata + | Metric | Unit | Perfometer | | ------ | ------ | ------ | -| METRIC 1 | bit/s | yes | -| METRIC 2 | C | yes | -| METRIC 3 | V | no | +| in/out prefixes | count | no | +| prefixes accepted | count | yes | </details> @@ -58,33 +64,20 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi ### WATO <details><summary>Service monitoring rule</summary> -| Section | Rule name | -| ------ | ------ | -| Networking | NAME_OF_THE_RULE | - -| Option | Defailt value | -| ------ | ------ | -| OPTION 1 | 10/50| -| OPTION 2 | 70/90 | -| OPTION 3 | CHOICE 1 | -| OPTION 4 | disabled | +See [BGP Peer](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer "BGP Peer") </details> <details><summary>Discovery rule</summary> -| Section | Rule name | -| ------ | ------ | -| Discovery of individual services | NAME_OF_THE_RULE | - -| Option | Defailt value | -| ------ | ------ | -| OPTION 1 | disabled | +See [BGP Peer](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer "BGP Peer") </details> <details><summary>HW/SW inventory rules</summary> -The inventory plugin is not configurable. + +See [BGP Peer](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer "BGP Peer") + </details> --- -- GitLab