VMware Powershell Healthcheck script

Healthcheck is a Powershell script that reports information like snapshots, VMware tools version, datastore space, CDROM and/or floppy drives connected etc. to HTML and e-mail the output to a person or distribution list.

Reason for creating this script:

As VMware Consultant I see a lot of common problems in VMware environments like:

– Snapshots are enabled and forgot the commit to the VM.

– Datastores are almost full (for example if snapshots are enabled)

– VMware tools versions are different

– CDROM and floppy drives are still mounted to the VM

– Virtual Machines have CPU and Memory limits or reservations (VMs are swapping)

– In the VM, the VMware Tools timesync option is not enabled

In the Virtual Infrastructure Client (VIC) it is difficult to see this sort of information. By creating a Powershell script,  I can do a quick inventory.  In a lot of VMware environments I created a scheduled tasks, so the script runs once a week and sent to HTML rapport to the administrator.

What does the script:

I wrote a Powershell script with HELP from the VMTN community that makes a HTML file and sent the output by e-mail to a person or distribution list.  The Healthcheck script does the following checks:

– VMware ESX hardware

– VMware ESX versions

– VMware VirtualCenter versions

– Active snapshots

– CDROM and Floppy drive(s) mounted to the VM

– Datastore information like capacity, free space and the percentage free space

– VirtualMachine (VM) information like VMware tools version, CPU, Memory reservations and limits etc.

– On what VMs VMware Tools timesync is not enabled

Requirements:

The following software must be installed:

Microsoft Powershell 1.0 (http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx)

VMware Infrastucture (VI) toolkit for Windows 1.0

http://www.vmware.com/download/sdk/

Set the ExecutionPolicy in Windows Powershell to RemoteSigned by using the following command:

set-ExecutionPolicy RemoteSigned

Installation:

– Unzip the Healthcheck.zip script to a directory on the VC server for example.

– When the ZIP if unpacked there are two files:

– Healthcheck.ps1, this is the Powershell script

– Style.CSS, controls the HTML layout

Configuration:

– Edit the Powershell.ps1 file

edit the following variables:

$vcserver=”localhost”

Enter the VC server, if you execute the script on the VC server you can use the localhost name

$filelocation=”D:\temp\Healthcheck.htm”
Specify the location where to store the HTML output

$enablemail=”yes”
Enable (yes) or disable (no) to sent the script by e-mail

$smtpServer = “mail.ivobeerens.nl”
Specify the SMTP server in your network

$mailfrom = “VMware Healtcheck <powershell@ivobeerens.nl>”
Specify the from field

$mailto = ivo@ivobeerens.nl

Specify the address where the e-mail to sent  to

Usage:

Manually run the Healthcheck.ps1 script”:

1. Open Powershell

2. Browse to the directory where the Healthcheck.ps1 script resides

3. enter the command:

./Healthcheck.ps1

To create a schedule task in for example Windows 2003 use the following syntax in the run property:
Powershell -command “& ‘path\Healthcheck.ps1’
edit the path

Powershell -command “& ‘path\Healthcheck.ps1’

edit the path .

Future:

– List Orphaned VMDK’s

– Add performance information like VM usage

– Check timesync on the VMware hosts

Happy testing 🙂

Download Link: Healthcheck script

The script is posted on the VMware Powershell contest forum, link

Some screenshots of the HTML output:

 

1JPG

2

3

 

[ad#verticaal]

38 thoughts on “VMware Powershell Healthcheck script

  1. Very nice work. I have found this script to be very usefull. I have a couple of suggestions.

    1) Change the CSS to be part of the HTM file so that is it not dependent on the style.css file. This will make it so that the report maintains the style even when e-mailed.

    ConvertTo-Html –title “VMware Health Check ” –body “Date and time”,$date -head “body { background-color:#EEEEEE; } body,table,td,th { font-family:Tahoma; color:Black; Font-Size:10pt } th { font-weight:bold; background-color:#CCCCCC; } td { background-color:white; } ” | Out-File -Append $filelocation

    2) I added the following so that I could have the report send to a network share (IE. Sharepoint)

    $enablnetshare=”yes”
    $netshare=”\\server1\share2\subdir1\subdir2\etc.”

    ####################################
    # Copy to Sharepoint Netowrk Share #
    ####################################
    if ($enablnetshare -match “yes”)
    {
    copy $filelocation $netshare
    }

  2. Well, looks like the blogging engine stripped out the style tags on suggetion 1, but you get the point.

    Thanks again

  3. After a bit of trial and error. Find the two ConvertTo-Html lines and replace them with this!

    ConvertTo-Html –title “VMware Health Check ” –body “VMware Health script” -head ” body { background-color:#EEEEEE; } body,table,td,th { font-family:Tahoma; color:Black; Font-Size:10pt } th { font-weight:bold; background-color:#CCCCCC; } td { background-color:white; } ” | Out-File $filelocation

    ConvertTo-Html –title “VMware Health Check ” –body “Date and time”,$date -head ” body { background-color:#EEEEEE; } body,table,td,th { font-family:Tahoma; color:Black; Font-Size:10pt } th { font-weight:bold; background-color:#CCCCCC; } td { background-color:white; } ” | Out-File -Append $filelocation

  4. Very Nice script.. Thanks..

    Peter can you share the ConvertTo-Html lines. This is my email Id “firoz_basha@aol.in”

    Thanks in advance

  5. Very very nice, great work! I suggest the following enhancement to see the size of each windows disk in a VM, space used, space free and percent free (not just percfree). I however did not sort by percent free as it’s sorted by VM, up to you! I used some new variables which are also listed.

    ##################################################
    # Percentage freespace on partitions in the VM #
    ##################################################

    $hdCapacity = @{ N = “Capacity (GB)”; E = { % { $_.Capacity / 1000000000 } } }
    $hdFreeSpace = @{ N = “FreeSpace (GB)”; E = { % { $_.FreeSpace / 1000000000 } } }
    $hdSpaceUsed = @{ N=”Used (GB)”; E={ ( $_.Capacity – $_.FreeSpace ) / 1000000000 } }
    $hdPercFree = @{ N=”PercFree”; E={ [math]::Round( ( 100 * ( $_.FreeSpace / $_.Capacity ) ),0 ) } }

    Get-VM | Where { $_.PowerState -eq “PoweredOn”} | Get-VMGuest | Select VmName -ExpandProperty Disks | Select VmName, Path, $hdCapacity, $hdSpaceUsed, $hdFreeSpace, $hdPercFree | ConvertTo-Html –title ” Percentage freespace partitions inside the VM” –body ” Percentage freespace on partitions inside the VM.” -head “” | Out-File -Append $filelocation

  6. Please send to me too maher74[at]Hotmail[dot]com
    i tried not using the CSS file but just dont want to work

    thanks..

  7. more simple to embedd the css

    ##include the css
    $CssFileName=”.\style.css”
    $css = Get-Content $CssFileName
    $style =””+$css+””
    ## include it in the first call to the convertTo-Html
    ConvertTo-Html –title “VMware… ” –body “VMware…” -head $style | Out-File $filelocation
    ## and remove all other -head

    And the final result is a html mail with a nice look
    This is working perfect in my variant of the script
    -ph Koenig-

  8. This is a really nice script, please forward ConvertTo-Html details to dcarter[at]family[dot]co[dot]uk

    Thanks

    D

  9. @admin

    Ivo,

    I’ve scheduled this script as a scheduled task with a service account with administrator rol in VC (Datacenter level). Worked perfect untill we upgraded to VC2.5U4.

    What could be the reason??

    Also the VI Toolkit got updated, maybe this is the reason?

    Current VI Toolkit version:

    VI Toolkit Version
    ——————
    VMware VI Toolkit for Windows 1.5 build 142961

    Any help muchely appreciated!

  10. Can you pleasae send me the update script with the ambedded CSS code as well?

    my email is pc21geek[AT]yahoo[DOT]com

  11. This is a amazing script . It helped my 2 weeks work .. !!

    Is there a script which would help me to disconnect CRDOM’s on bunch of VM’s at a shot

  12. Thanks for your script

    Is it possible to add color in the html file for percfree. for example red color if percfree less than 10%

  13. Hey there, I haven’t checked the source of your powershell script out yet, but is this still compatible with vSphere? Are there any cmdlets run that could potentially modify the VC database? Or is everything in this just to retrieve info? Trying to figure out whether this would be safe to run against our vCenter environment now….

  14. Hi,

    How to have the final html report i.e., $filelocation to be displayed as a body of the mail message.

    Thx.

  15. I didnot get the response to the above question

    “Is it possible to get vm health report in XML Format similar to HTML”

    Please reply, it is urgent

    thanks,
    Vijay.

  16. Hi, This is very useful script, Can anyone send me the update script with the ambedded CSS code as well on hemant_patel@symantec.com.

    I tried to change in existing script but didnt work for me in emailed report.

    Thanks,
    Hemant

  17. Its very useful script, I have modified some fields according to my requirements… Thanks Ivo Beerens

  18. I have some issues when I run the script twice. The report on VM information adds on to the list which has some errors. Anyone has any errors similar?

    Is there an updated script for this? Appreciated it.

    Can send to me @ rockermocker84@gmail.com

  19. Instructions on how to protect usernames and passwords
    http://vmwaremine.com/2013/04/19/schedule-task-with-powercli-script/
    #To create the credential store files
    New-VICredentialStoreItem -Host ESX-or-vCenter-Hostname -User username -Password ‘password’ -File C:\path-where-to-store-file.xml

    #To use the data stored in the XML file, we will call the Get-VICredentialStoreItem
    $Credential = Get-VICredentialStoreItem -Host vcenterserver -File C:\path-where-to-store-file.xml

    #Use the $Credentials variable for the username and password switches in the Connect-VIServer
    Connect-VIServer vCenterserver-or-ESX-host -User $Credential.User -Password $Credential.Password

Leave a Comment