Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com

Skip to content
README.md 2.61 KiB
Newer Older
thl-cmk's avatar
thl-cmk committed
[PACKAGE]: ../../raw/master/mkp/vsphere_topo-0.0.1-20240709.mkp "vsphere_topo-0.0.1-20240709.mkp"
thl-cmk's avatar
thl-cmk committed
# vSphere Topology Visualization
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
This plugin uses the data from the _VMware ESX via vSphere_ spezial agent to create a topolofy of the vSphere environment.
thl-cmk's avatar
thl-cmk committed
It creates the Topology on the fly with each check cycle. The topology contains the vCenter -> Data center -> Clutser -> VMs -> Datastore.
thl-cmk's avatar
thl-cmk committed

---
### Download
* [Download latest mkp file][PACKAGE]

**Note**: before you update to a newer version, always check the [CHANGELOG](CHANGELOG). There migth be incompatible changes.
                        
---
### Installation

You can install the package by uploading it to your CheckMK site and as site user run 
```
mkp add PAKAGE_NAME.mkp
mkp enable PAKAGE_NAME VERSION
```

In the Enterprise/Free/Cloud 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")

---
### Check Info

thl-cmk's avatar
thl-cmk committed
The plugin creates the service **_vSphere Topology_** on each discovered vCenter server.
thl-cmk's avatar
thl-cmk committed

<details><summary>Montoring states</summary>

thl-cmk's avatar
thl-cmk committed
The service state is always ok.
thl-cmk's avatar
thl-cmk committed

</details>

<details><summary>Perfdata</summary>

| Metric | Unit | Perfometer |
| ------ | ------ | ------ |
thl-cmk's avatar
thl-cmk committed
| Time taken | s | yes |
thl-cmk's avatar
thl-cmk committed

</details>

---
### WATO
<details><summary>Service monitoring rule</summary>

| Section | Rule name |
| ------ | ------ |
thl-cmk's avatar
thl-cmk committed
| 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 |
thl-cmk's avatar
thl-cmk committed


</details> 

<details><summary>Discovery rule</summary>
thl-cmk's avatar
thl-cmk committed
Tere is no discover rule.
thl-cmk's avatar
thl-cmk committed
</details> 

<details><summary>HW/SW inventory rules</summary>
thl-cmk's avatar
thl-cmk committed
There is no inventory rule.
thl-cmk's avatar
thl-cmk committed
</details> 

---
### Sample Output

Sample output

thl-cmk's avatar
thl-cmk committed
![sample output](img/sample.png?raw=true "sample output")
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
Sample vSphere topology
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
![sample output details](img/vsphere_topology.png?raw=true "sample vSphere topology")
thl-cmk's avatar
thl-cmk committed