diff --git a/README.md b/README.md index b3c8c04d2064201703935d7dab6df7a43c1a326e..923aeebfd931980786523a4579706694c982da90 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,9 @@ [PACKAGE]: ../../raw/master/mkp/bgp_topology-0.0.2-20241223.mkp "bgp_topology-0.0.2-20241223.mkp" -# Title +# BGP Topology -A short description about the plugin +This plugin will create a Network Visualization Topology from the Peer relations of your _BGP peer services_ in Checkmk. -if there are more than on plugin put it in collapsable sections -<details><summary>check_plugin_1</summary> - -</details> -<details><summary>check_pluhin_2</summary> - -</details> +**Note**: This check is an active check and needs to be associated with one of the hosts in Checkmk. Usually a host with BGP peers. --- ### Download @@ -36,15 +30,11 @@ 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 +The plugin creates the service **_BGP Topology_** <details><summary>Montoring states</summary> -| State | condition | WATO | -| ------ | ------ | ------ | -| WARN | condition 1 | yes | -| CRIT | condition 2 | no | -| WARN/CRIT | condition 3 | no | +The service state is always ok. </details> @@ -52,43 +42,34 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi | Metric | Unit | Perfometer | | ------ | ------ | ------ | -| METRIC 1 | bit/s | yes | -| METRIC 2 | C | yes | -| METRIC 3 | V | no | +| Time take | s | yes | </details> --- ### WATO -<details><summary>Service monitoring rule</summary> +<details><summary>Active check rule (HTTP, TCP, Email, ...)</summary> | Section | Rule name | | ------ | ------ | -| Networking | NAME_OF_THE_RULE | +| Networking | BGP Topology | -| Option | Defailt value | -| ------ | ------ | -| OPTION 1 | 10/50| -| OPTION 2 | 70/90 | -| OPTION 3 | CHOICE 1 | -| OPTION 4 | disabled | +| Option | Defailt value | Options | +| ------ | ------ |----| +| Anchor for external BGP objects | Both | AS, ID, Both | +| BGP AS emblem | icon_cloud | None, Default, Custom | +| BGP ID emblem | icon_topic_system | None, Default, Custom | +| Make default | Disabled | Enabled, Disabled| +| Filter Checkmk sites| None | Include/Exclude sites | </details> <details><summary>Discovery rule</summary> - -| Section | Rule name | -| ------ | ------ | -| Discovery of individual services | NAME_OF_THE_RULE | - -| Option | Defailt value | -| ------ | ------ | -| OPTION 1 | disabled | - +There is no service discovery rule </details> <details><summary>HW/SW inventory rules</summary> -The inventory plugin is not configurable. +There is no inventory rule. </details> --- @@ -96,9 +77,9 @@ The inventory plugin is not configurable. Sample output - + -Sample output details +Sample BGP Topology - +