LabTech VMWare ESXi Heath Monitor Plugin v3

On May 16, 2014, in Projects, Scripting, by Cubert aka (Cube Dweller)

 

ESXi Health Monitor Plugin

weblogo

 

 

Well it’s finally here, the plugin we have all been waiting for, Vmware ESXi Health Monitor plugin for Labtech. This plugin installs into your Labtech system as a Location plugin to monitor the CIM data available in most hardware. Easy to configure controls and full view of the CIM data collected is just part of what this plugin can do. We have incorporated new functions into this plugin that are stark differences from our earlier version 2 and version 1 ESXi Health Monitors. We are now supporting multiple usernames and passwords per location for ESX hosts and only require 1 probe system to monitor all the ESX hosts at a single location. I could talk all day about the plugin but maybe it’s better if I show you.

 

Here is the main view of the ESXi Health Monitor plugin.

mainview

The hosts get listed with status face based on current status and when you select a host the CIM data is displayed so you can see all the reported statuses of the hardware.

 

This is the ESXi host configuration tab of the ESXi health Monitor plugin.

config-tab

This is where you will add and edit your host systems to monitor, you can set the system you want to be responsible for probing the ESXi hosts for the CIM data. Then you select a system and “Set” it as the probe the plugin will launch a script against the probe to prep it for monitoring automatically. You will not need to “install” the probe software manually as this is handled by the plugin when the probe system is selected.

The ESXI Health Monitor plugin uses a custom group to locate all the probes available by using a custom search to locate all systems with the EDF of “VMware Master CIM Scanner” selected as seen it the example below. You will find this setting under the Info tab -> VMWare on any system console. Just checking it will not install probe software so you must “Set” the probe via the plugin.

master-scanner

The Custom group should look like this and have the custom search setup as seen in this example.

group-join-search

The custom group also has a scheduled script to run every 2-4 hours and I use the exclude time range as I do not need this data so bad that I can’t sleep with out it running every hour or 2. This is just my personal preference but saves on CPU cycles during backup windows and maintenance schedules. You will need to reset this when you import your group as this seems to always get rest to nothing during imports.

group-schedule-probe

You can see your probe run on the system by watching the script logs on the probe systems console. This helps when troubleshooting common issues.

probelogs

This version is in Beta! this is the first release of this plugin and as such may have odd behavior issues and or may not work for you as expected. I seriously doubt you will have any issues but as this is Beta expect a few minor glitches. We are actively working on updates and with your help we can make this a great plugin!

You can run the version 2 and version 3 side by side and they will not effect each other.

Updates:
———————————————————————————————————-

Changes in New Version 0.3.0.3

Changed Version number back to what it should of started at. It was a typo starting with (3)
Added Internal monitor called CIM –  VMWare ESXi Health Monitor
Added Client View and Global View of System Statuses
Corrected a few minor coding mistakes
Added Linux Probe Support
Updated the data views

 

Changes in New Version 0.3.0.5

Added Last Scan Time Stamps
Added color coded data views
Added new images

Changes in New Version 0.3.0.6

Fixed Scan Time not updating

Changes in Version 3.0.7

Updated Python Packages to 2.7.8
Fixed several SQL issues with table creation.
Minor enhancements

Changes in Version 3.0.8

Added new instant host probe from the configure tab
Fixed minor issues in plugin
Fixed issues with installer script

Changes in Version 3.0.9

Fixed CIM Monitor in LT
Fixed Versioning context
Fixed password bug when resaving the same password for esx probe.

 

Changes in Version 3.0.10

Fixed Issues with Installer where latest PY script requires several new Python modules.

New Client Level View

mainview

This view give you a look at all systems under the clients control. you can select the system and review the CIM data returned.

This plugin monitors the condition all the systems and will alarm when a system is found to be in error. You can customize the alarms and the methods of alerts received through the Monitors management interface in Labtech .

monitors_alarm

You can download the latest version here.

Version 3.0.10 Now Available

download

Download extra packages only if needed 

If you like what we are doing then please donate to our cause, help keep our software free.

How to install plugin

 

Please post here any comments and issues you may have so we can get them fixed and out in the next release.

Enjoy

Cubert 😎

Tagged with:
 

127 Responses to “LabTech VMWare ESXi Heath Monitor Plugin v3”

  1. Nick says:

    Hi There,

    First, thanks for this addin. However, I just simply cannot get it installed! Please can I get step by step instructions, with images if possible, on how to get this installed and working.

    Total Noob here…

  2. Yes it apart of the original Python25 Zip, You can copy it out of 25 folder and into the new one if needed. I will look to update the python package for this plugin as soon as I can get a round TUIT.

  3. Dylan says:

    I have the plugin installed, groups and monitors are all there and configured.

    However, when running the “Install ESX CIM Probe Application V3” script, it always fails at step 9 (transferring of a zip from the ltshare)

    The zip “esxi_monitor_application.zip” doesnt exist, where do I download this? is labtech supposed to auto generate this file? because it hasnt.

  4. Dylan says:

    I found it, I didn’t read hard enough the extra files link had that zip.

    -1 for skimming

  5. Eric Hoffmaster says:

    This is fantastic! Thank you so much for creating this.

    We implemented it today, and everything is working. We have the plugin showing the CIM data for all of our configured hosts.

    Our CIM data doesn’t list any internal hard drive or RAID status like it does in the screenshots. We also have several items listed as “Not Available”. Is there anything more we need to do in order to get the rest of the information we need? We are using HP ESXi servers.

  6. Justyn says:

    We have tried to implement this but after adding the plugin and importing all the scripts we don’t get a new tab under info>vmware.

    I hacked it together by editing the search and creating my own additional field. It pulls in data after I do that successfully. But we also are missing the new internal cim monitor and I didn’t see anything in the 3.0.7 to import for that monitor.

    Just wondering if I am missing a step.

    Thanks in advance for any reply

  7. Cubert says:

    You must have,

    If the tab doen’t show then check plugin manager to make sure it is “checked” as active. Next restart console and goto any client location console and see if a ESXhealthMonitor tab exists.

    From there configure hosts and set a probe system to do the data collections.

  8. Eric Hoffmaster says:

    We don’t have the internal monitor after setting everything up. I tried to run the query listed in the earlier comments to create the monitor, but I get a syntax error (copy/pasted exactly).

    Cubert, could you please provide guidance on this? Thank you.

  9. Cubert says:

    ok download the monitor XML import file here

    http://www.squidworks.net/CIM-ESXMonitor.zip

    Use the LT XML importer, should create a Internal monitor called CIM- VMware ESXi Health Monitor

  10. Eric Hoffmaster says:

    Thanks Cubert! That worked like a charm.

    Regarding my previous comment, do you know why the CIM data doesn’t include any drive or array data? It contains CPU, memory, temperature, power etc., but no drive info.

    We still have a few items with Not Available as the status. Is this normal, or is there something more that we need to do?

  11. Cubert says:

    The python script in c:\python27\check_esxi_hardware.py reads the CIM data for the hardware and if something does not report a good or bad then it is marked as Not Available. This is perfectly fine as that item may not exist in that hardware.

    You can run the “Update Python ESX Probe script which will visit the website of the developer of the check_esxi_hardware.py script and grabs the latest version. Visiting site may help you identify hardware that is/is not as compatible …

  12. We have just released version 3.0.8 which adds a new host testing feature on the config tab of the plugin. You can now probe in real time the CIM data from any host under management and see it’s return in the plugin.

    Very cool..

    Also fixed a few bugs and an issue with the Probe installer script.

  13. Hi Cubert!

    Again.. awesome work with this plugin!! 🙂

    I went through your guide and everything works great, and I have CIM data being returned, however the ONE thing I’m missing is the “CIM – VMWare ESXi Health Monitor”, internal monitor.

    Would you mind exporting that and posting it up here?

    Thanks a bunch!
    Martyn.

  14. Ah… never mind buddy! I see that you already did on a previous comment!!
    My bad. I ran the SQL export and all is good!

    Regards,
    Martyn.

  15. Richard Phillips says:

    Hi There,

    Just installed the plugin as it says in the Readme File. However if i go to a location and click the ESXHealth Monitor tab i get an unhandled exception of “Object Reference not set to an instance of an object”

    ************** Exception Text **************
    System.NullReferenceException: Object reference not set to an instance of an object.
    at ESXHealthMonitor.ESXHealthMonitor_uc.LoadHosts()
    at ESXHealthMonitor.ESXHealthMonitor_uc.ESXHealthMonitor_uc_VisibleChanged(Object sender, EventArgs e)
    at System.Windows.Forms.Control.OnVisibleChanged(EventArgs e)
    at System.Windows.Forms.ScrollableControl.OnVisibleChanged(EventArgs e)
    at System.Windows.Forms.Control.OnParentVisibleChanged(EventArgs e)
    at System.Windows.Forms.Control.OnVisibleChanged(EventArgs e)
    at System.Windows.Forms.ScrollableControl.OnVisibleChanged(EventArgs e)
    at System.Windows.Forms.Control.SetVisibleCore(Boolean value)
    at System.Windows.Forms.TabPage.set_Visible(Boolean value)
    at System.Windows.Forms.TabControl.UpdateTabSelection(Boolean updateFocus)
    at System.Windows.Forms.TabControl.OnSelectedIndexChanged(EventArgs e)
    at System.Windows.Forms.TabControl.WmSelChange()
    at System.Windows.Forms.TabControl.WndProc(Message& m)
    at System.Windows.Forms.Control.ControlNativeWindow.OnMessage(Message& m)
    at System.Windows.Forms.Control.ControlNativeWindow.WndProc(Message& m)
    at System.Windows.Forms.NativeWindow.Callback(IntPtr hWnd, Int32 msg, IntPtr wparam, IntPtr lparam)

    Any ideas?

    Many Thanks

  16. Aran Kaspar says:

    Thanks very much for the post and replies!

    I’ve imported everything as described and I’m stuck at the location level ESXi tab which is showing but info is blank. I was able to add the IP address and I get a green shield next to it but no info.

    Any help is very very much appreciated!

  17. Brett says:

    Thanks for your work on this. I do have a couple of issues though.

    I’m curious if this works on the Labtech 10 pilot install. I installed the plugin and imported the xmls.

    The 2 main issues are: If I run the CIM Probe install script against a server, it appears to install yet, when I go to Configure, I never get anything showing up under “select a system as a CIM Probe. The drop down list is blank.

    Also, I can’t get the internal monitor to show up.

    Thanks for any help you can give.

  18. Yes it does support LT10, I have tested and I get all functions as normal.

    Keep in mind that you select the probe from the list and the plugin does the install for you. You will want to make sure that you have restarted the DBagent on the LT server to make sure all tables were created before using plugin. Then goto the location of ESX host and open location console. Find ESX tab and and select the configure sub tab then select the probe drop down. It should show you all windows systems at that location. Select a system and click Set Probe to start the install on that system and to set the flag that it is now a probe.

  19. Brett says:

    Cubert,

    I was able to get the plugin to start working with the probe after a server reboot.

    The issue that remains is the internal monitor is not showing up. Is there a way to manually install/set it up/ or reimport it?

  20. Aran Kaspar says:

    Hi again,
    Thanks for this tool, I was wondering if I could get some input.
    I can’t find the monitor and have tried multiple methods of importing.
    I’ve selected probes and input IPs login info into the location level ESXi tab
    I get a Green shield with a blank info field, Nothing displays beyond that.

    I’ve recently attended CharTec academy who says they were also unable to get this working.

    Can you give me your thoughts?
    We are hosted and still have 2013 I believe.

  21. Aran Kaspar says:

    also have tried the scripts for updating CIM probe app, update python, VMware monitor probe… not sure where exactly to successfully use them though
    testing the connection just sits there with the symbols for hours on end

    Is there something I have to configure on the server end? if so, hypervisor lever or OS level?
    Where to use those scripts?
    Which version of LT should I have?
    How to best troubleshoot/test this feature?

    Again, many thanks for your hard work getting this together.
    FYI- I have enabled CIM monitoring in ESXi and created a user specifically for it.

    aran@moonknight.com

  22. Brett says:

    Cubert,

    I have the 2 issues on my end, similar to Aran.

    CIM – VMware ESXi Health Monitor is not showing up in my monitors.

    Also, When I configure a CIM Probe and ESX host, it shows to test fine and pulls data. but I never see any data on the status page. It remains blank. Any ideas?

  23. Michael says:

    Similar to Brett’s situation, I think.
    Have a client with a mix of ESXI 4.1 and 5.5. We got the plugin installed okay after multiple restarts of both the database and the Control Center, and we were able to set the probe PC, add some ESXI hosts and use the test button to confirm that it’s all working – woohoo!
    Only problem we have now is that other than the list of servers itself, nothing shows up in the Status tab, even after 24hrs…? Tried selecting one and clicking, right-clicking, hitting Enter etc, no matter what we do the right-hand section titled “Last Scan Time” remains blank.
    Has anybody else run into this? Did we just miss something in the Readme steps?

  24. If the tests run ok and no data in 4 hours then the group either is empty of probes or the group scheduled scripts is missing the run scan script that should be scheduled every 4 hours.

    I do not have my LabTech in front of me but open your group for ESX probe systems in your groups list and check for machines that you asigned as a probe for a location, if they are not there then the install of Python failed. If they are there then look at the groups scheduled scripts tab, does this have the ESX probe script set for every 4hours?

    If you have no probes in group try rerunning set probe and monitor scripts tab of that system for errors and post them here.

    If they are in group set script by selecting the scanner script from the VMware scripts folder for every 4 hours. You can also manually run that same. Scrip against group at any time to refresh the data, allowing time for scripts to run on hosts.

  25. We released a new version 3.0.9 that fixes the CIM monitor not showing up for people.

  26. Aran,

    No special ESX hots configs needed, will work out of the box on any ESXi systems.

    Set a probe, allow it to complete install of probe softwares, should auto join the ESX group, script runs against group every 4hours to populate data.

    Verify probe installed by seeing c:\python27 exists and is complete on probe, verify that the check box is set on the info tab of probe console, verify it shows in group, and that group is executing script then lastly look at probe scrip tab on console to see script errors and success logs. What dies? Post that here and we will get you an answer for that error and how to fix it.

  27. Michael says:

    Aha! It works now!
    The probe was in the group but no script was scheduled.
    I found/scheduled the script named “VMWare ESXi HealthMonitor Probe 3.1” but it was located in the root of the scripts, not in the “/VMWare/VMWare ESXi Health Monitor 3.1/” script sub-folder where I suspect it belongs.
    This may be the reason it didn’t get added to the schedule automatically.

  28. Vik says:

    i am having a problem with saving configuration of CIM probe. right hand bottom SAVE button is greyed out. Please help. Also status has the esxi host listed with green tick but no data

  29. Vik,

    send me a screenshot at sanderson@, I am not sure why a button would be greyed out?

  30. Aran says:

    Thanks for your replies Cubert, can’t wait to get this thing working.
    Here’s what I got from my 2008 VM (DC/DNS/Exchange)

    Script: Install ESX CIM Probe Application V3.1
    The script(5845) failed in the THEN section at step 9

    Start .ESXi CIM Monitoring\Install ESX CIM Probe Application V3.1
    IF File Check Parameter1: C:\Python27\ Parameter2: 1 Parameter3: Time Taken: 41768.102
    L1 Script Note Parameter1: First lets check, are we a win Parameter2: Parameter3: Time Taken: 41779.204
    L5 Script Note Parameter1: Lets download our Python packa Parameter2: Parameter3: Time Taken: 41779.604
    L6 Folder Create Parameter1: %ltsvcdir%\Packages Parameter2: Parameter3: Time Taken: 41779.704
    L7 File Delete Parameter1: %ltsvcdir%\packages\esxi_monit Parameter2: Parameter3: Time Taken: 41782.805
    L8 Folder Delete Parameter1: %ltsvcdir%\packages\esxi_monit Parameter2: Parameter3: Time Taken: 41782.918
    L9 File Download Parameter1: Utilities\VMWare\esxi_monitor_ Parameter2: %ltsvcdir%\packages\esxi_monit Parameter3: Time Taken: 41783.019

  31. Aran says:

    If I check location ESXi tab and Status tab…
    I have a green shield next to my hosts IP address… no data in the right-side field.
    When Testing the host on the configure page, I get this….
    Starting Scans
    Start CIM Collection on 192.168.99.201
    >> %ltsvcdir%\CIM\192.168.99.201.txt
    No CIM Data for 192.168.99.201 continuing on to next host.
    The script(5843) was successful in the THEN section.

    Start S5843
    IF F95 P1:32c6e3aa-d95c-11e3-b28a-005056 P2:94 P3:2 T:64560.905
    L2 F154 P1:%ltsvcdir%\CIM P2: P3: T:64561.106
    L3 F20 P1:1 P2:1 P3:HOSTCOUNT T:64568.207
    L4 F196 Parameters Hidden T:64568.307
    L5 F139 P1::HOSTCIMLOOP P2: P3: T:64568.418
    L6 F29 P1:Inside CIM Loop [1] P2: P3: T:64568.518
    L7 F197 P1:sqldataset P2:1 P3: T:64568.619
    L8 F20 P1:1 P2:192.168.99.201 P3:ESXHOST T:64568.719
    L9 F20 P1:1 P2:dell P3:VENDER T:64568.819
    L10 F29 P1:Collecting CIM data from 192.1 P2: P3: T:64568.919
    L11 F29 P1:c:\python27\python.exe C:\Pyth P2: P3: T:64569.019
    L12 F109 P1:c:\python27\python.exe C:\Pyth P2: P3:PYTHONCMD T:64569.12
    L13 F235 P1:0 P2:#—————————– P3: T:64573.222
    L14 F20 P1:7 P2:%ltsvcdir%\CIM\192.168.99.201. P3:MYSQLSTMT T:64579.445
    L15 F101 P1:1 P2:0 P3:1 T:64582.546
    L16 F70 P1:MYSQLSTMT P2:9 P3:, T:64582.646
    Script Engine – MYSQLSTMT variable doesn’t exit – Performing Legacy Comparison
    L33 F29 P1:No CIM Data for 192.168.99.201 P2: P3: T:64582.746
    L34 F70 P1:HOSTCOUNT P2:5 P3:1 T:64582.846
    L35 F129 P1: P2: P3: T:64582.946

    The script(5845) failed in the THEN section at step 9

    Start .ESXi CIM Monitoring\Install ESX CIM Probe Application V3.1
    IF File Check Parameter1: C:\Python27\ Parameter2: 1 Parameter3: Time Taken: 82407.771
    L1 Script Note Parameter1: First lets check, are we a win Parameter2: Parameter3: Time Taken: 82413.872
    L5 Script Note Parameter1: Lets download our Python packa Parameter2: Parameter3: Time Taken: 82414.272
    L6 Folder Create Parameter1: %ltsvcdir%\Packages Parameter2: Parameter3: Time Taken: 82414.372
    L7 File Delete Parameter1: %ltsvcdir%\packages\esxi_monit Parameter2: Parameter3: Time Taken: 82417.474
    L8 Folder Delete Parameter1: %ltsvcdir%\packages\esxi_monit Parameter2: Parameter3: Time Taken: 82417.576
    L9 File Download Parameter1: Utilities\VMWare\esxi_monitor_ Parameter2: %ltsvcdir%\packages\esxi_monit Parameter3: Time Taken: 82417.678

  32. Cubert says:

    looks like your problem is the

    L:\Transfer\Utilities\VMWare\esxi_monitor_application3.1.zip

    File is not at this location.

    Search your Transfer directory for files and move them to correct place. Or download from link above “Download extra packages only if needed ” and and copy files from zip to the L:\Transfer\Utilities\VMWare directory.

  33. aran says:

    Of course!
    Wow. Well I’ll see what we can do with Labtech, we’re hosted so I’m not sure if they’ll let us upload it but we’ll have to see.

  34. Vik says:

    thanks Cubert, i have sent you emails with couple of screenshots.

  35. Cubert says:

    See if you have a “Transfer Directory” under your tools menu of the LT console. This should redirect you to your online file stores.

    Make sure that the files are in the Transfer\Utilities\VMWare\ of that directory

  36. RB says:

    I’m having a bit of trouble with this.

    I’ve added the scripts and put the files in the labtech folder.

    For Install ESX CIM Probe Application V3.1 I had to put check_esxi_hardware.py in the L:\Transfer\Scripts folder and it worked.

    I’ve added the plugin and its enabled.
    After a server restart I still have no ESXi tab on any of my monitoring servers.
    I tried running the HealthMonitor Probe 3.1 and it fails the SQL Fetch DataSet Row portion (Fetch row @HOSTCOUNT@ from dataset sqldataset)

    Under the info tab the “This system monitors a ESX host” box is uncheckable.

    I do see the CIM – WMware ESXi Health Monitor.

    I had initially tried installing the 2.1 version without luck as well.

  37. Cubert says:

    RB,
    Shoot me a email at sanderson@ and I will be glad to setup a Go To Meeting to have a peak at your setup.

    I am sure it is something minor your missing..

  38. Everyone, I posted a how-to Video on installing and setting up the plugin here on this page.

    http://www.squidworks.net/2014/05/labtech-vmware-esxi-heath-monitor-plugin-v3/

    If your having issues with getting plugin working then this video is for you.

  39. Rick says:

    For some reason my ESX host are not showing physical drives with v3. Anyone else run into this?

  40. Jimmy James says:

    Hey has anyone tried the ESXi Health Monitor Plugin with Labtech 10 yet?
    I’m still running Labtech 2013 and have just been approved for the upgrade to Labtech 10. But wondering if the ESXi Health Monitor Plugin is compatible?

  41. Imran Sadiq says:

    Hi, I am getting this error when testing a host.
    Starting Scans
    Start CIM Collection on 10.55.0.236
    ><
    Traceback (most recent call last):
    File "C:\Python27\check_esxi_hardware.py", line 229, in
    import pkg_resources
    ImportError: No module named pkg_resources

    Scan is now complete.

    And go the following when I installed the probe under the scripts
    Extensions install -> The system cannot find the path specified.
    The system cannot find the path specified.
    The system cannot find the path specified.
    The system cannot find the path specified.

    C:\Windows\system32>cd C:\Python25\pywbem

    C:\Windows\system32>C:\Python25\python.exe C:\Python25\pywbem\setup.py build

    C:\Windows\system32>cd C:\Python25\pywbem

    C:\Windows\system32>C:\Python25\python.exe C:\Python25\pywbem\setup.py install

    Any ideas?

    Thanks,

  42. Jimmy, I am on 10 and it works Great!

  43. @Imran – Make sure your running version 3.09 and then from the error above you look to be missing the “pkg_resources”.

    You should check the Probe system for a C:\Python27\Lib\site-packages directory to exist, if not then there was an issue when installing python, Check your zip package for this to be included as a zip package. Make sure that the file locations for this set of zips are in the correct places for download when the installer is run..

  44. Elias says:

    I just had the pkg_resources issue as well. From what I can tell it looks like the updated version http://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.py has an “import pkg_resources” entry while the check_esxi_hardware.py script that comes with 3.09 does not. I tested the latter and it works when I replace the updated script. I’m disabling the update script on my group for now and will re-download the older version. I’m guessing the install needs to be updated to include the pkg_resources dependencies.

  45. Imran Sadiq says:

    Hi, thanks for that. I did manage to load the old version 3.09 and that seem to fix the original issue.

    However when I run the script against a host. I am getting the following error.

    “No CIM Data for 10.55.0.236 continuing on to next host.”
    Even though I can see the file created in

    “%ltsvcdir%\CIM\10.55.0.236.txt” and has all the information in it.

    Any ideas?

  46. Narolad says:

    I’m still having the same issue above with the pkg_resources but even after replacing the script it still errors out about missing modules. Is there a another place I need to grab the script or rebuild the modules at?

  47. the original script that came in the zip package should be plenty, I would uninstall Python27 and reinstall using the installer script or by setting probe again.

    Look in %ltsvcdir%\packages\esxi_monitor_application\Python27\
    for this script check_esxi_hardware.py along with other files that are extracted during install.

    Note you may need to disable line 29 in the install ESX CIM Probe script so that it does not delete these files after install.

    Also disable line 34 where we force a download on the latest version of CIM probe script from http://www.claudiokuenzler.com/

    This should prevent the issues you have with missing packages.

  48. For those who are having issues with the latest CheckESX scripts, I have now updated to Version 3.0.10 which should resolve this going forward. Any probe having this issue should be reinstalled after you update to version 3.0.10.

  49. Steven says:

    I have no idea what I am missing. I’ve watched the video several times now and I cannot get the probe installed on my PC. I installed the plugin according to the video but I cannot get the Install ESX CIM Probe Application V3.1 script to do anything but sit in a queued state.

  50. Steven says:

    Figured it out. My script engine was hung up.

Leave a Reply