From 6fac015525a12b8b407d94e6f2f91a0b554bee91 Mon Sep 17 00:00:00 2001 From: thl-cmk <thl-cmk@outlook.com> Date: Wed, 10 Jul 2024 17:12:57 +0000 Subject: [PATCH] Update README.md --- README.md | 65 +++++++++++++++++++++++-------------------------------- 1 file changed, 27 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 6362bf4..b821f5c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,9 @@ [PACKAGE]: ../../raw/master/mkp/vsphere_topo-0.0.1-20240709.mkp "vsphere_topo-0.0.1-20240709.mkp" -# Title +# vSphere Topology Visualization -A short description about the plugin - -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> +This plugin uses the data from the _VMware ESX via vSphere_ spezial agent to create a topolofy of the vSphere environment. +The Plugin creates the service _vSphere Topology_ on each found vCenter. It than creates the Topology on the fly with each check cycle. +From left to right, the topology start with the vCenter -> Data center -> Clutser -> VMs -> Datastore. --- ### 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 **_vSphere Topology_** on each discovered vCenter server. <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,9 +42,7 @@ 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 taken | s | yes | </details> @@ -64,31 +52,32 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi | Section | Rule name | | ------ | ------ | -| Networking | NAME_OF_THE_RULE | +| Applications, Processes & Services | vSphere Topology | + +| Option | Defailt value | Comment| +| ------ | ------ |----| +| Adjust ESXi host names | none | | +| - Keep domain name | Disabled | Enabled/Disabled | +| - Change case |no change | upper/lower/no change | +| - Name prefix | none | Prefix for host names | +| Adjust VM names | none | Same as Adjust ESXi host names only for VMs | +| Cluster emblem | icon_plugins_hw | none, default, custom | +| Datacenter emblem | icon_cloud | none, default, custom | +| Datastore emblem | icon_services_green | none, default, custom | +| Add data store service | Disabled | Enabled/Disabled | +| Make default | Disabled | Enabled/Disabled | +| Don't add vCenter as VM | Disabled | Enabled/Disabled | +| Add dummy topologies | Disabled | Enabled/Disabled | -| Option | Defailt value | -| ------ | ------ | -| OPTION 1 | 10/50| -| OPTION 2 | 70/90 | -| OPTION 3 | CHOICE 1 | -| OPTION 4 | disabled | </details> <details><summary>Discovery rule</summary> - -| Section | Rule name | -| ------ | ------ | -| Discovery of individual services | NAME_OF_THE_RULE | - -| Option | Defailt value | -| ------ | ------ | -| OPTION 1 | disabled | - +Tere is no discover rule. </details> <details><summary>HW/SW inventory rules</summary> -The inventory plugin is not configurable. +There is no inventory rule. </details> --- @@ -96,9 +85,9 @@ The inventory plugin is not configurable. Sample output - + Sample output details - + -- GitLab