VMware vSphere Health Check Report v5.1.0

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

c33jbeckwith · ‎07-15-2010

Just installed the new v4.1.0 script in vMA and I am seeing the following against a standalone VMware ESXi, 4.0.0, 261974 host:

Can't locate object method "vStorageSupport" via package "HostScsiDisk" at ./vmwarevSphereHealthCheck.pl line 2458.

End Disconnect

lamw · ‎07-15-2010

The new v4.1.0 should be installed on vMA 4.1 or greater. It's having a problem trying to look up properties that do not exists as you're using older version of the SDK. I've made it backwards compatible if you're on 4.1 but not the other way around.

You should only be using v4.1.0 if you have 4.1 hosts in your environment, else there is nothing new for vSphere 4.0

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

c33jbeckwith · ‎07-15-2010

Gotcha. I read the notes in the beginning of the KB differently. Thank you for the clarification.

LarryBlanco2 · ‎07-21-2010

In looking at the results (HTML) from the script. I am getting incorrect version numbers for the vCenter and ESXi servers I have. My 4.1 servers are stating they are "VMware ESXi 4.0.0 build-236512" when they are actually ESXi 4.1.0 260247. Same goes for the vCenter Server an I only have one vCenter server. The script states it's "VMware vCenter Server 4.0.0 build-258672" when it's really 4.1.0 258902.

When running the script it throws out 2 errors which are the same:

Use of uninitialized value in concatenation (.) or string at C:\Program Files (x

86)\VMware\VMware vSphere CLI\bin\vmwarevSphereHealthCheck\vmwarevSphereHealthCh

eck.pl line 878.

Use of uninitialized value in concatenation (.) or string at C:\Program Files (x

86)\VMware\VMware vSphere CLI\bin\vmwarevSphereHealthCheck\vmwarevSphereHealthCh

eck.pl line 878.

Lastly, I am running the script using vSphere Cli 4.1, and using the following:

vmwarevSphereHealthCheck.pl -server myvcs --username mydomain\vmware --password ***** --type vcenter

Thanks!

LarryBlanco2 · ‎07-22-2010

Disregard the above. For some reason it is now working correctly.

Thank you,

Larry

Rincey · ‎07-22-2010

Hi William

This script seems like it might be exactly what I'm looking for, but unfortunately I was getting the same error as c33jbeckwith, as I'm not yet using vSphere 4.1 - we have no immediate plans to upgrade from 4.0 across all of our virtual infrastructure, so I have a need to run the previous version of your script.

I can't seem to find the previous version though. I have found v0.9.5 (for VI3.5), and I found http://communities.vmware.com/docs/DOC-12456 which doesn't have a download link. It just has the code as text on the webpage, so I tried copy/paste into a blank .pl file, but generated 200+ errors when I ran it on the vMA appliance, so the copy/paste operation could not have got all the script (I tried it from both chrome and IE) (maybe due to a webpage formatting issue - e.g. CR/LFs in wrong places - I'm not sure. EDIT: on closer inspection, the code snippet only contains 4000 lines of code whereas v4.1.0 contains almost 5000. It looks like the snippet is cut off in the middle of a subroutine - makes sense that it wasn't working :smileygrin:).

So, a link to a downloadable version 4.0.x would be hugely appreciated.

Cheers in advance

Scott

lamw · ‎07-22-2010

I actually missed a section in the script where it checks on the version of the API (vStorageSupport error you're seeing) and I've just updated the script. You will now be able to run this on both vMA 4.0 and vMA 4.1 system. If you're managing vCenter or ESX(i) 4.1 hosts, you must use vMA 4.1.

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

c33jbeckwith · ‎08-02-2010

running into one other problem that I have not seen mentioned. The new 4.1.2 script works without issue when I am querying a single host. However, when I query vCenter (running in eval mode currently but that should not be an issue) I get the information for the vCenter itself, but not the attached host. I don't see anything in reference to additional flags when I am contacting the vCenter.

Thanks in advance!

azsysteam · ‎08-04-2010

I run the script to check esxi 4.1 server but failed with following errors.

This can take a few minutes depending on environment size.

Get a cup of coffee/tea and check out http://www.virtuallyghetto.com

Can't locate object method "systemFile" via package "HostConfigInfo" at D:\exsi_

tool\vmwarevSphereHealthCheck\vmwarevSphereHealthCheck.pl line 1659.

End Disconnect

athlon_crazy · ‎08-07-2010

Me too, no problem when running on top of EXS/i hosts but failed on vSphere Hypervisor 4.1 with below error :

Can't call method "enabled" on an undefined value at C:\Program Files\VMware\VMware vSphere CLI\bin\vmwarevSphereHealthCheck.pl line 2522.

http://www.no-x.org

lamw · ‎08-07-2010

I'm assuming you're running on vMA 4.1? and your infrastructure is all 4.1? Do you have a cluster created?

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

lamw · ‎08-07-2010

Are you using vMA 4.1? Are you running this on a licensed or free version of ESXi 4.1?

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

lamw · ‎08-07-2010

Are you using vMA 4.1? Are you running this on a licensed or free version of ESXi 4.1?

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

metz · ‎08-10-2010

First of all, great script! I use this to report our Infrastructure since Version 4.0.0 on a weekly basis.

I have vMA Version 4.0, ESX Hosts Version 4.0 and vCenter 4.0

Since the last update of the script to 4.1.2, the report will not include any information about 3rd Party Apps and I don't know what I can do, to bring them back into?! I've running the older Version 4.0.8 after that, to check if there are errors in my infrastructure, but the report looks fine, and 3rd Party Apps are included.

You can have a look at your sample report, it doesn't include 3rd Party Apps, too!

What's going wrong? The sub "getVMwareApps" seems to be unchanged...

c33jbeckwith · ‎08-10-2010

William, here are the particulars:

vCenter 4.0u2

Single ESXi 4.0u2 host

AD integrated authentication.

I have both the 4.1.2 and the 4.0.8 code installed. I have the same problem with each script. vCenter information pulls without issue, no addtional information is displayed.

Thanks!

lamw · ‎08-10-2010

I'll need to see if I have some time to verify this on vMA 4.0, I had tested the script and it should work on either 4.0 or 4.1.

Regarding my sample report, that should not be used to compare what you should see on report. At the time of running the script, I had rebuilt our dev environment and we don't have any 3rd party applications. Remember, it's primarily 3rd party applications who have a specific hook into VMware such as VUM, vDR, etc. and there is some metadata that is provided for me to query for that information.

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

lamw · ‎08-10-2010

What version of vMA are you using?

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

c33jbeckwith · ‎08-10-2010

Running vMA 4.0 and if memory serves me correctly I have updated to vCLI 4.0 U2 within vMA. I have no problem building a fresh vMA if that would assist with information gathering. I would assume since I am on the 4.0 train that I need to be on vMA 4.0 as well.

Thanks for the assistance.

lamw · ‎08-10-2010

I'm trying to understand the environment and potentially try to reproduce. atm, it sounds like it's only with vMA 4.0 on a 4.0 environment and potentially with U2. I was able to run the latest version of the health check script on a vCenter 4.0u1 with 4.0 hosts without any issues. I'm not aware of any changes that would cause the hosts to not show up.

The only thing is, you need to make sure your hosts are part of a cluster, that is requirement else it will not be able to query hosts and VMs.

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

c33jbeckwith · ‎08-10-2010

As it turns out you hit the nail on the head. I built a small dev environment to perform testing of a few new monitoring applications etc, but did not create a cluster for the single host that was being managed by the vCenter. Once the cluster was created, the script runs without issue. Thanks for the assistance.

lamw · ‎08-10-2010

whew...yea there should not be any issues running vMA 4.0 or 4.1.

I know today, the script does not provide any error or warning messages. This sounds like something I need to add so it's clear. I'm assuming this probably what the other user is running into as well.

Thanks

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

c33jbeckwith · ‎08-26-2010

William

One item I think would be nice to see if it is possible to add in a future release, would be to add a field under Hosts > ESX/ESXi Datastores to reflect how many VM's are utilizing that particular LUN. In environments with a large amount of LUN's where consolidation of datastores is being looked into, it would be great to use this tool to target LUN's that are less populated.

Great job on this script. It has become a staple in my arsenal of tools I use almost every day.

CJ Beckwith

vancod · ‎08-26-2010

Actually, that sounds really handy.....

maboe · ‎09-16-2010

Dear William,

I got the same problem like "azsysteam":

Can't call method "enabled" on an undefined value at C:\Program Files\VMware\VMware vSphere CLI\bin\vmwarevSphereHealthCheck.pl line 2522.

He did not answer your question, for me it´s:

vMA Version 4.1

Free Version of ESXi 4.1

The report is created, but the host information is emty.

apesma1 · ‎09-22-2010

I have the same software configuration as you state above, although I issue my command via batch script:

/home/vi-admin/scripts/vmwarevSphereHealthCheck/vmwarevSphereHealthCheck.pl --server myserver.edu --username just --password pretend --type host --printerfriendly yes --report myserver.html

which yields the same result:

Can't call method "enabled" on an undefined value at /home/vi-admin/scripts/vmwarevSphereHealthCheck/vmwarevSphereHealthCheck.pl line 2522.

lamw · ‎09-23-2010

This particular lines checks if Storage I/O Control is enabled, this part of the code is only valid for vSphere 4.1 and there is a check prior to that to see verify the version before going into this section of code. If you're using the latest version, you should not get an error whether you're using vSphere 4.0 or 4.1

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

apesma1 · ‎09-23-2010

Thank you so much for your reply.

Using vMA Version 4.1 and Free Version of ESXi 4.1

I am assuming the tar.gz on this web page is the latest version. If not Is there a newer version elsewhere?

If it is the latest, then it appears the version check is working as we expect as I do enter that section of code correctly.

However, lines 2522-2533, where the $iormEnable and $iormThres variables are assigned fail.

Note: This issue appears to happen only to esxi4.1 hosts. The program completes fine on esx4 vsphere hosts.

As a test, commenting the above lines out at least lets the rest of the program finish.

lamw · ‎09-23-2010

Yes the latest version is on here, I'll have to test this out when I get a chance to see what the outcome is. I'll get back to you

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

vancod · ‎09-23-2010

William -

I noticed that the email function is not working, in that it's not reading the data set in the config file.

If I manually edit the .pl it works great, but if I strictly edit the config file I get:

Error: Unable to setup connection with email server: "emailserver"!

lamw · ‎09-23-2010

I've tested both editing the script and using a configuration file. If you can provide more details and what you're setting the configurations files to, I might be able to help. Pretty swamped still, but I'll try to get back to you but I'm pretty sure it works. The other thing you can try is to print out the values of the email configurations and NOT edit the script email settings to see if it actually is reading in the right information.

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

http://geeksilver.wordpress.com/2010/07/28/vmware-vsphere-4-1-storage-io-control-sioc-understanding/

If you find this information useful, please award points for "correct" or "helpful".

vancod · ‎09-23-2010

Sure - the settings I used in the config file (with NO edits to the script) are as follows:

EMAIL_HOST=owd-exch1.customer.local

(NOTE: I tried with "just hostname" and with FQDN here - same result)

EMAIL_DOMAIN=customer.local

EMAIL_TO=Customer@customer.gov

EMAIL_FROM=vMA@Cluster1.customer.local

With just these values set in the config file I get:

Error: Unable to setup connection with email server: "emailserver"!

If I put those

SAME values

in the corresponding places of the script, I have complete success.

There is NO NEED to hurry on this for me - I have it working, and for the target environment this is totally a non-issue.

Also, to let you know, there is a typo in the output. On the "Hosts" page you will see "COS VDMK
" - I can only assume you mean to have VMDK there....

maboe · ‎09-24-2010

I think Storage I/O Control is not available in free version of vSphere 4.1.

Maybe that´s the problem?

apesma1 · ‎09-24-2010

I think you nailed it. I did some digging and found this:

According to that article, In addition to a esx 4.1 host as a requirement, you also need the vcenter server system up and running as well as an Enterprise License.

lamw · ‎09-27-2010

Actually the licensing has nothing to do with the property, yes this feature is only available with 4.1, but querying on whether SIOC is enabled or not should not depend on the license. What's happening is SIOC is only available under VMFS volumes, my guess is that you have an NFS volume and when the script tries to validate this, it fails and throws the error.

I believe this can be fixed by changing line 2521 to the following which checks that the datastore is of type VMFS:

if(($hostAPIVersion eq "4.1.0" || $hostAPIVersion eq "4.5.0") && $ds->summary->type eq 'VMFS') {

Let me know if this resolves the problem.

Thanks

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

varaway · ‎09-28-2010

Hi Mr William Lam,

very nice script.

The section with the VM Snapshots are very important for us, thanks.

But, is it possible to make a small sript only find the snapshots as in the full report??

Thank, for help

apesma1 · ‎09-28-2010

You are correct. I am using an NFS Volume in both esxi 4.1 hosts. My apologies for not pointing this out at the outset.

The line change you made at line 2521 appears to have resolved the problem and the script now completes successfully.

A feature question: Does your script list the startup/shutdown order of VM's within an esx/esxi host? I'm hoping it does and I just missed it.

Thank you for a most excellent script!

lamw · ‎09-28-2010

Hi varaway,

Please take a look at the documentation, specifically the section called Custom Report Configuration which allows you to fully customize the report. If you're only interested in snapshot info, you can leave that enabled and disable all other checks.

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

lamw · ‎09-28-2010

apesma1,

Thanks for confirming, I'll make sure this fix is in the next release. Regarding startup/shutdown, no that is not being captured today. I'm not sure exactly how it would be displayed, as it currently displays VMs based on their display name which is listed in alphabetical order if I recall correctly. I don't have any plans on changing that.

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

truo1van · ‎09-28-2010

Hi William,

We have VC with 2 datacentres in it. Whe I run the script with "--type vcenter" the report only give inform about 1 datacentre (all clusters + hots within it etc..).

I know there is switch to specfify which datacentre to get inform from. Is there way to run the script just once to get inform for ALL datacentres in the VC ie, without havginto run mutiple times?

I just realise that even to specify the --datacentre there is no inform collected for the particular 2nd datacentre. I think it is because this datacenter does NOT have Cluster/Hosts structure ie, I group the Hosts in a Host Folder, there is no Cluster (since the ESX hosts are local onsites, geographically separate). I belive your script report on Datacentre is based on Cluster/Hosts structure?

thanks

Van

lamw · ‎09-30-2010

Hi truo1van,

I can confirm the script supports for multiple datacenters, but the key is that you must have a cluster defined in which the hosts are under. Even if you don't use any of the "cluster" features, from a scripting perspective, there are certain things I extract out which is much easier at a cluster level. That is most likely why you're not seeing information being captured in the other datacenter. You should be able to create a cluster and just have HA/DRS disabled and stick with the defaults and re-run the script and it should work.

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

truo1van · ‎10-01-2010

thanks William,

Thought about that, in facted had tried it. HOwever, we have more than 100 hosts in the 2nd clusters. This breaks the cluster limit max. Anyway, if need be I can put them in Host list and run the scripts against it. HAvent not tried it but should be ok.

I want to use this script to generate reports for management and they r only interested in some key aspects of the report from viewpoint of performance and/or capacity planning ie, Host performance/utlilisations wrt CPU, RAM, Disk IO.., VM CPU/RAM utils, VMs created in the last 7 days (configurable para)..

The default report has excelletn inform for tech guys like but I need somehtings more "less interlligent" for managt.

How can I turn off selective report aspects??.

PS: I have not tried to turn on the performance switches for Host/VM/Cluster yet so not sure what it can gives (will surely try next week). If usefull, can I have the 3 switches on in command line? instead of having to run 3 times? Am I correct to assume that?

Again. thanks very much.

VanT

truo1van · ‎10-01-2010

Followup. Just have a look at your sample report's performance sections for Hosts and VMs. THey have the averages.. what are the durations of taken to work out the avarages?

vancod · ‎10-01-2010

Tried 4.1.3 yesterday from a 4.1 vMA against a 4.0 vCenter:

email still not working as intended (from config file)

Turned off VMware/3rd party Apps - report still contained the "dead" tab

Turned off VPX settings - VPX data still appears in report

(HMM - almost seems like the config file is being ignored entirely?????)

Also - in the VM section, there were a couple of VMs that showed up "in the yellow" for Overall Status - and the cell is merely labeled "VM" - is there supposed to be more information?

I've also been curious about something - is there any way to get the report to look like the "old" script - where it was all just one long, simple HTML file?

lamw · ‎10-01-2010

truo1van,

Please take a look at the documentation, specifically the section called Custom Report Configuration which allows you to fully customize the report. You will be able to select only a subset of what the report generates.

PS: I have not tried to turn on the performance switches for Host/VM/Cluster yet so not sure what it can gives (will surely try next week). If usefull, can I have the 3 switches on in command line? instead of having to run 3 times? Am I correct to assume that?

There already exists 3 separate switches to control performance data for cluster,host and VM. Please read the documentation.

Thanks

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

lamw · ‎10-01-2010

vancod,

1) I've not been able to re-produce your email issue, though haven't dug super deep and hence it was not called out in the change list. What email server are you using specifically? I've tested using postfix and it works fine.

2) VMware/3rd Party Apps - I'll look into it, I think by default the tabs are auto-generated but no data will be populated.

3) VPX Settings, I'll look into it, last I checked this works

Could you either attach or PM your config file, I want to make sure you don't have any typos I'm sure you don't, but these are things I've tested in the past and the code snippets have not changed.

Also - in the VM section, there were a couple of VMs that showed up "in the yellow" for Overall Status - and the cell is merely labeled "VM" - is there supposed to be more information?

Nope, this is an overall status of the VM, a property that it's exposed via the API to give you a quick look at any given VM, no additional information.

I've also been curious about something - is there any way to get the report to look like the "old" script - where it was all just one long, simple HTML file?

Yes, please take a look at the documentation and use the flag --printerfriendly which makes it into one long HTML report. This was added for those that wanted to print the report but provides the same functionality.

Thanks

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators

If you find this information useful, please award points for "correct" or "helpful".

sammyvm · ‎10-05-2010

So I've now uploaded the new health script to our vMA's, but unfortunately I cannot get it to work no matter what I've tried, and fails on the following error:

Syntax: ./vmwarevSphereHealthCheck.pl --server server01 --username XXXX --password XXXX --type vcenter

Error: "Can't use an undefined value as an ARRAY reference at ./vmwarevSphereHealthCheck.pl line 468"

If I run the old version of the script (1.5.2) it works fine even with the advanced options including forwarding emails, collecting all the performance data etc... This latest build 4.1.3 it just errors out while running even the simplest method.

My setup:

vMAs are 4.1

vCenters are 4.0 update 2

ESXi Hosts are 4.0 update 2

line 468 appears to be in the sessions area of the script. Anyone else have had experience with this type of error?

Cheers

lamw · ‎10-05-2010

I think the issue is when it only finds 1 active session and it tries to perform a sort on the name to display the output. Try modifying the code starting at line 468:

                if($demo eq "no") {
                        my $sessionMgr =  Vim::get_view (mo_ref => $sc->sessionManager);
                        my $sess_list = $sessionMgr->sessionList;
                        if(@$sess_list ne 1) {
                                foreach(sort {$a->userName cmp $b->userName} @$sess_list) {
                                        $summary_start .=  "<tr><td>".$_->userName."</td><td>".$_->fullName."</td><td>".$_->loginTime."</td><td>".$_->lastActiveTime."</td></tr>\n";
                                }
                        } else {
                                foreach(@$sess_list) {
                                        $summary_start .=  "<tr><td>".$_->userName."</td><td>".$_->fullName."</td><td>".$_->loginTime."</td><td>".$_->lastActiveTime."</td></tr>\n";
                                }
                        }
                } else {
                        $summary_start .= "<tr><td>DEMO_MODE</td><td>DEMO_MODE</td><td>DEMO_MODE</td><td>DEMO_MODE</td></tr>\n";
                }

Let me know if this works and I'll go ahead an get this updated in the next release.

=========================================================================

William Lam

VMware vExpert 2009,2010

VMware scripts and resources at:

VMware Code Central - Scripts/Sample code for Developers and Administrators