VMware vSphere Health Check Report v5.1.0

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

VMware Developer Comuunity

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

arjaysam1 · ‎02-11-2010

Thanks for your quick response, William. I appreciate your help and the fixes you are going to make. I'm hoping to have the script running with VMA at all my customer sites as it meets a need head on. Thanks again.

Robert

vancod · ‎02-11-2010

William is the bomb!

(W - I haven't given up trying to inject customizable CSS templates into this script, but like you there are eleventy-billion other priorities)

If anyone is curious, I'm hoping to automate formatting to look like this:

(with user-controlled colors)

http://ocnav.com/test.html

80% there - nested tables are crushing my will to live......

lamw · ‎02-12-2010

Very cool, looking forward to the final product with the custom colors.

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

VMware Developer Comuunity

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

5truja · ‎02-20-2010

Would you pease help. I am getting the following error when running this to a vcenter and I get only part of report:

Can't call method "type" on an undefined value at /usr/lib/perl5/5.8.8/VMware/VICommon.pm line 1244.

VCP

lamw · ‎02-21-2010

Unfortunately this is a very generic error message and does not really pin-point where within the script the issue occurred in. If you have a partial report generated, can you let me know up to what part was completed populated by the script? I'm assuming you're executing this against a vSphere environment with ESX(i) 4.0 hosts?

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

5truja · ‎03-01-2010

Well I could send it to you. The thins is that I have few datacenters and it starts to run repport and takes just as you mentioned just part of one (or few esx servers) of our datacenters....

VCP

lamw · ‎03-01-2010

Do you always run into the error? (e.g. what if you ran it against individual ESX host? cluster? datacenter?)

If you can run it on a smaller entity such as a host or individual datacenter, then it might be easier to troubleshoot and you can send me a copy of the report.

Thanks

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

5truja · ‎03-01-2010

The thing is that I have two vCenters environments and I am running vMA on one of ESX hosts belonging to one vCenter. Health check is running fine on vCenter object here. When I am running healthcheck on the other vCenter object the script is running and i generated but it does not take all of the ESX hosts and/or objects but is intreruppted instead with above mentioned error message. Does it mean that I need to install one more vMA for the other vCenter (and ESX hosts/VMs in it). If the answer is Yes how come that some of ESX apperas anyway in this partial repport?

VCP

lamw · ‎03-01-2010

You can have 1 vMA run across any vCenter, host, etc. you don't need more than one. The reason you're only seeing a subset of the report generate is there is 'something' that is either not handled correctly in the script regarding a specific configuration setup on one of the host which is causing the script to halt. Since you've been able to isolate it to the one of the 2 vCenters, take a look at at the report that's generated and see which ESX(i) host it was still processing, once you get that, then run a report specifically on that host and see if you get the issue OR if it only occurs when running against vCenter and it gets to that host. Once you isolate it there, then you can send me the report and I can take a look at what section the code breaks down and I may need to ask few additional questions depending on where the reports stops. Hopefully that make sense

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

5truja · ‎03-09-2010

All of sudden everything works fine This is great. The only thing that is different is that I upgraded my vCenter to Update 1.

Thanks a bunch for help

VCP

lamw · ‎03-09-2010

Ah cool to hear, that technically shouldn't have made a difference. This script is specific for vSphere in general, whether that's 4.0 or 4.0u1.

Either way, glad to hear you got it working

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

5truja · ‎03-10-2010

Would you please explain something. When checking the repport and part with datastore for esx i see values for free datastore space and uncommited space. Uncommited space value is higher than free space. I am guessing thing provisioning here but anyway what is the right trigger and what uncommited vs free gives me than?

VCP

E_A_ · ‎03-17-2010

Hi William

first things first: Thank you very much for this script it rocks!

I noticed you mentioned a new feature (--clusterperforamnce there is a typo in the example ) introduced in the version 1.5.3 but it seems I can download from this link only the version 1.5.2.

Do you mind update the copy attached?

Thanks in advance.

lamw · ‎03-17-2010

Hi,

I've just re-uploaded the latest version, let me know if you're seeing the new version of the script. Also the typo should be fixed.

Thanks

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

http://www.dailyhypervisor.com

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

E_A_ · ‎03-18-2010

Yes. I have the new version now and works like a charm.

Thank you!

E.A.

benma · ‎03-19-2010

Does anybody found a way to send the mail to more than one recipients?

aheckman · ‎03-19-2010

I second this question!

I have tried seperating two email addresses by comma and semi-colon and it doesn't like either, bombs the whole email function.

Example (part of healthCheck.conf):

EMAIL_TO=cderemer@phoebe.org; aheckman@phoebe.org

or

EMAIL_TO=cderemer@phoebe.org, aheckman@phoebe.org

but just

EMAIL_TO=cderemer@phoebe.org

Work Great!

Troy_Clavell · ‎03-19-2010

Simply brilliant William. Thanks again for doing such a great job and making my life so much easier!!

dconvery · ‎03-19-2010

Why not just create a group email account and use that?

Dave Convery, VCDX

VMware vExpert 2009

http://twitter.com/dconvery

Careful. We don't want to learn from this.

Bill Watterson, "Calvin and Hobbes"

lamw · ‎03-19-2010

Thanks Troy! Glad it's helpful, let me know if there are any other features that might be useful to add.

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

lamw · ‎03-19-2010

@benma @aheckman

I'll take a look to see if this is possible with what is available with the default installation of the vSphere SDK for Perl, this functionality is definitely available but may not be with the default Perl modules that's included with the vSphere SDK for Perl or on vMA.

I prefer not to require additional packages for end-users to have to install and the current limitation is with the Perl module that's being used for email, it most likely only supports 1 recipient.

As Dave mentioned, you could also just use a DL

Thanks

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

kstieers · ‎03-19-2010

@William,

You just need to use an array for @EMAIL_TO.

#################

EMAIL CONF

#################

my $EMAIL_HOST = "mail.opus.corp.root";

my $EMAIL_DOMAIN = "opuscorp.com";

my @EMAIL_TO = ('user@domain','user2@domain'); # use an arrar instead of a scalar

my $EMAIL_FROM = 'VCenter@opuscorp.com'

And tweak the sendmail function:

sub sendMail {

my $smtp = Net::SMTP->new($EMAIL_HOST ,Hello => $EMAIL_DOMAIN,Timeout => 30,);

unless($smtp) {

die "Error: Unable to setup connection with email server: \"" . $EMAIL_HOST . "\"!\n";

}

open(DATA, $report_name) || die("Could not open the file");

my @report = , SkipBad => 1 });

$smtp->to(@goodrecips);

$smtp->data();

$smtp->datasend('From: '.$EMAIL_FROM."\n");

$smtp->datasend('To: '.@EMAIL_TO."\n"); # changed this....

Ken

lamw · ‎03-19-2010

Nice! Yea I never dug too deep and would be surprised if this wasn't supported with the default Net::SNMP package.

I'll give this a test and then update the script when I get a chance, will be busy this weekend so hopefully get it into the script by next week.

Thanks again!

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

ukCloud9 · ‎03-19-2010

nice script.

I'm trying to run it, from the vMA, and I get

Can't use an undefined value as an ARRAY reference at ./vmwarevSphereHealthCheck.pl line 405.

I'm not sure if this might be due to the username password format I'm using

e.g. username: "mydomain\myuser"

password: This@pwd

I wondered if I needed to somehow escape the '\' in the domain name, or the '@' in the password?

lamw · ‎03-19-2010

It should not matter, if you entered it in plain text, you just need to double quote it. I believe what you're running into is an issue when the list of sessions are returned.

Could you try changing SYSTEM_SESSION="yes" to "no" either in the script or if you're using the healthCheck.conf, just update it there and re-run to see if you can get pass that.

Generally if it was a connection issue such as bad username/password, it would have halted right away and not go further into the script and in your case, it got through which means you were able to login successfully.

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

lamw · ‎03-21-2010

Altix,

Thanks for the comments and suggestions!

1) Regarding the NFS issue, I'll go ahead and also check to ensure the datastore is accessible prior to extracting data from it, this should eliminate this problem.

2) I'll go ahead and update the style to include this additional padding, as you can see, I'm not web design guy what so ever This definitely beats the old "gray" scheme

3) Let me do some testing, but I believe this value is actually correct and it goes back to how this is actually being calculated by VMware, unfortunately this "memory usage" value is not the same as "consumed" which is what you're most likely looking at.

4) I'll double check this, I thought I had fixed this awhile back but perhaps missed it during the re-write.

I'll try to get these updated in the next release which should also include multiple email recipients support.

Thanks again!

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

lamw · ‎03-21-2010

Altix,

Just release v4.0.1 which includes some of your suggestions.

Regarding the NFS issue, I actually do check to see if it's accessible, perhaps even though it's "considered" mounted by ESX(i) host, it could still have some issues. If you can provide further details or how to potentially replicate the issue, I could perhaps add additional checks. This may be corner case and might be something that needs to be resolved on the end user before running the script.

Regarding the Memory usage for the cluster stats, the result is in fact correct. If you take a look at the API reference document for how mem.usage.average is calculated: http://www.vmware.com/support/developer/vc-sdk/visdk400pubs/ReferenceGuide/memory_counters.html at the cluster level:

Cluster: memory usage = memory consumed + memory overhead ÷ effectivemem

If you do the math, you should come up with the same value which is what the script is reporting on. This is the expected value and actually I had a case opened up with VMware a few weeks back and this is correct/expected value by engineering. Though what we all like to see is actually the "consumed" amount as a percentage but that's not available today, you have to do some math to get an actual percentage.

The hardware sensor bug was actually reported earlier in this post: http://communities.vmware.com/docs/DOC-9842#comments-14445 but I must have missed it while doing the re-write. This should not be reporting the correct values.

Give the new script a try and let me know if you run into any other issues.

Thanks!

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

AdrianOConnor · ‎03-22-2010

Hi William,

Very basic question as I have zero *nix knowledge..

Downloaded and installed;

vMA-ovf-4.0.0-161993

vmwarevSphereHealthCheck.tar.gz

Ran the following

./vmwarevSphereHealthCheck.pl --server VC_SERVER --username VC_USERNAME --password VC_PASSWORD --type vcenter

Which worked fine, created a vmware_health_report.html file

How can I get the webserver to display the reports?

Is the website installed by default?

Thanks for the script and vm by the way, the sample pages I have seen to far look very promising.

Adrian

lamw · ‎03-22-2010

Adrian,

vMA does not have a webserver by default, so you would not be able to view the report directly on the system. You can however install apache if you would like, but it's really meant to be used to manage and configure your ESX(i) hosts and should be kept as slim as possible.

What you'll want to do is transfer the report off of the vMA host using something like scp (do a search for WinSCP) if you're on a Windows platform. This will allow you to copy out files and then view it on your own system or a server that does have a webserver.

Note, you can also send the report as an email if you have an email server which then allows you to create a simple schedule to automate the report if you like.

If you want to even further automate this to pull the report into say an intranet webserver, you could use something like VMware VIX and vmrun to basically extract the report and upload it to your webserver. This is something I've actually done for some internal reporting and basically is automated everyday to upload to the site.

Hopefully this gives you a few ideas on displaying the report.

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

truo1van · ‎03-23-2010

Hi William,

The scripts works good for me: using RCLI in Windows, --passtruauth works. VC4U1. Havent had chanhce to look thru all the informs in report, but they ARE so impressive.

Question: How can I get to specify where the report go to? ie, be default it is writtent to .."C:\Program Files\VMware\VMware vSphere CLI\bin\" or where I run the script. I want to be able to direct to somewhere else.

thanks

VanT

mako10z · ‎03-23-2010

Ver 4.0.1

I am using the Firefox Windows version. --JavaScript or CSS collapses when type host is used. It not repaired?

lamw · ‎03-23-2010

Hello,

Thanks for the comments.

Yes you can specify where the report is generated including the name of the report. Please take a look at the documentation from above and specifically at --report. Also note, you don't need to have the script stored under "C:\Program Files\VMware\VMware vSphere CLI\bin\....". By default, at least from what I've seen the vCLI/RCLI will set the correct path to the Perl interpreter, so you can even have the script run on your desktop and it'll output in the current working directory by default. Again, you can specify where it'll go and the name of the report.

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

lamw · ‎03-23-2010

Can you provide an example of what is "collapsing", either attach your report or send me the link via PM.

I've had one report of some CSS going crazy which I'm still investigating, running it in our own environment I've not seen the issue including up to multiple 32 node clusters. I'll see if I can resolve the current reported issue and provide an updated release which may resolve the problems you're seeing.

Thanks

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

mako10z · ‎03-23-2010

Upload: http://y17e.com/tmp/vmware_health_report.html

The file that deleted individual information was improved. It is glad when confirming it.

truo1van · ‎03-23-2010

THanks William,

the --Report works. Did not know I could use it to specify not only the name of the report but also the path.

chrs,

VanT

lamw · ‎03-23-2010

Could you try disabling the following in the report:

HOST_NIC=no

HOST_HBA=no

HOST_CONFIGURATION=no

HOST_LOG=no

and seeing if the report still produces the odd layout?

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

mako10z · ‎03-23-2010

It doesn't change though it invalidates. When it is a Japanese environment, is it useless?

lamw · ‎03-23-2010

Hi,

I'm having a little difficulty understanding your response. I don't believe it has anything to do with the language of the environment, it's most likely something that was missed in the html. Again, I'm currently working on fixing a few errors that I see, perhaps it'll resolve your problem.

I'll update when I get the new release out.

Thanks

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

AdrianOConnor · ‎03-24-2010

Again William, Thank you.

You are saving me a lot of work, which I always appreciate!!

lamw · ‎03-24-2010

Okay, I've been able to re-produce what you're seeing when connecting directly to a host, it looks like there is

that is miss-place which breaks the layout.

This will be resolved in the next release.

Thank you for bringing this to my attention.

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

mako10z · ‎03-24-2010

Hi. lamw

It releases, and we will wait.

cragdoo · ‎03-25-2010

I have an n00b perl question. Our vCentre and host passwords all contain a ! , which is a special character in perl , how I can I add this password to the --password parameter in my batch file

\vmwarevSphereHealthCheck.pl --server --username xxxxx --password xxxx!xxxx --type vcenter --conf healthcheck.conf

cragdoo · ‎03-25-2010

nope have tried that and single quotes ' ' , and \ and a combination of then all... still no joy

I can run the line from the command promt ok

C:\scripts\HealthCheck\vmwarevSphereHealthCheck.4.0.1\vmwarevSphereHealthCheck\vmwarevSphereHealthCheck.pl --server --username xxx --password "xxxxxx!xxxx" --type vcenter --conf healthcheck.conf

but when I wrap it up in a batch file , it fails with bad password ...weird

chele · ‎03-26-2010

Hi William

I have problems to complete the report. The script show the following error:

This can take a few minutes depending on environment size.

Get a cup of coffee/tea and check out http://www.engineering.ucsb.edu/~duonglt/vmware/

Use of uninitialized value in concatenation (.) or string at ./vmwarevSphereHealthCheck.pl line 2743.

Can't locate object method "slotInfo" via package "ClusterDasAdvancedRuntimeInfo" at ./vmwarevSphereHealthCheck.pl line 2760.

End Disconnect

Could you help me to run successfully the script?

Thanks and regards,

lamw · ‎03-26-2010

afaik, slotInfo should always have a value. In either case, I've put a fix to check and this will be included in the next release.

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

buckmaster · ‎03-26-2010

This is a great report. I use it all the time when performing health checks. I feel silly asking this but with the new design how to print all of the data since the layout is different?

lamw · ‎03-26-2010

I'm not sure what you mean? If you're referring to setting up custom report based on certain properties, please take a look at the documentation. There is no a configuration file you can pass into the script upon execution and depending on what you set to "yes", it'll display what you've selected.

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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

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

buckmaster · ‎03-29-2010

The previous healthcheck script produced a html report which when printed the entire html printed out. With the new design with tabs and the data being inside a frame not all pages will print, only current data in the current frame. Am I missing something really simple?

Suggestion: On healthcheck I always check the VM SCSI controllers. The VM-Converter most times will convert a w2k3 physical box and for some reason pick buslogic as the SCSI controller. We know best pratice is w2k3 servers should have lsilogic as the controller. Anyway when customers perform the P2V themselves they miss this. If the VM report section could provide the SCSI controller and OS that would be awesome.

lamw · ‎03-29-2010

That's a fair point, I know for larger environments, the report was slightly hard to read, at least using a computer, hence the new layout. If you want to print the entire report out, you'll need to tweak the CSS:

Search for this at the top:

div.tabcontents {
	height: 550px;
	background: #fff;
	overflow: hidden;
	border-top: 1px solid #011;
	padding: 20px;
	padding-bottom:30px;
}

and comment out "height: 550px;" which will have the report display 100% of the page.

Regarding your request, the OS type is already being displayed under "VM Configurations". With displaying the controller type, how would you like that displayed? especially for VMs w/multiple disks/etc. and under which section?

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

William Lam

VMware vExpert 2009

VMware ESX/ESXi scripts and resources at: http://engineering.ucsb.edu/~duonglt/vmware/

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