Navigation:  Remote Monitoring and Management > Proactive Monitoring > Windows Server and Workstation Monitoring > 24x7 Checks > Script Check > Default Script Checks >

Virtualisation

Previous pageReturn to chapter overviewNext page

 

There are a number of scripts available to monitor the following health indicators, alerting where a hardware fault is reported:

 

VMware ESXi - Datastore Free Space

VMware ESXi Health - CPUs

VMware ESXi Health - Fans

VMware ESXi Health - Memory

VMware ESXi Health - PSUs*

VMware ESXi Health - Sensors*

VMWare ESXi Health – Storage

VMware ESXi Virtual Machine Inventory

VMware ESXi Virtual Machine Power State

 

 

In addition to the above Script Checks there is also the VMware ESXi Virtual Machine Control Automated Task

 

Each of the Virtualisation scripts require the following basic information to successfully query the ESXi server with this entered in the Script Parameters section.

 

Script Parameters

Host

Address of the ESXi server

Username

Username for an account with the minimum required permission to query the CIM counters

Password

Password for this account

Script Timeout Range

Range: 1 - 150 seconds

 

clip0399

 

Information on setting up a user with the minimum level of permissions to retrieve this information from VMware pre-version 5.1 installations is available in the section: VMware : User Requirements Version 5.1 introduced a change to the way in which permissions are handled within VMware, as such the use of the root account may be necessary to allow the script to access the required indicators.

 

The Scripts can run from an Agent installed on a guest Operating System or from another server pointing back at the VMware device.

 

The output only shows a green tick if the API reports an OK state. Sometimes this may be Unknown which shows as a red cross.

 

Notes

Our VMware ESXi scripts are supported on ESXi 6.5 or earlier.

Script Language

The Virtualisation script language is either VBScript or PowerShell depending upon the monitored indicators.

 

Requirements

For both languages WinRM (Windows Remote Management) must be installed and the script have access to the VMware CIM / SMASH API. This uses the WSMAN library (which is not supported on XP, 2003 or earlier Operating systems)

 

Additionally for PowerShell scripts Microsoft .Net 3.5 (or higher), PowerCLI and PowerShell 2.0 (or later) must be installed on the device the scripts will be executed from.

 

Please note: PowerCLI is supported up to version 6.0. Later versions of PowerCLI (from 6.3) are currently unsupported and may results in unexpected results when running Checks.

 

PowerShell: the use of $ and other special characters in the password

Consideration must be given when passing passwords that contain special characters through PowerShell to ensure they are handled as literal strings.

 

For example if the password contains a dollar sign ($) it must either be preceded by a grave accent ` (also known as a backtick: ASCII code 96 - Alt+96) or the password encapsulated in single ' ' to pass the password to PowerShell exactly as entered.

 

Password Example

String

Result

pas$word

pas

pas`word

pas$word

'pas$word'

pas$word

 

Where the password contains a special character (in this example dollar sign) but no preceding grave accent, or is not encapsulated in single quotes, the message Failed to connect – Credentials invalid is returned.

 

Note: some PowerShell special characters are themselves constructed using a grave accent so should be encapsulated in single quotes when passed via the Script and these are covered in the Microsoft Technet article: about_Special_Characters

 

Further information on Escape_Characters and Quoting_Rules is available from Microsoft's Technet

 

Please be aware that we are not responsible for the content of external sites.

 

Failure condition

Please be aware that the ESXi Script Checks will only fail where a problem is detected, if a pass or unknown condition is reported the Script Check will pass. The condition indicators are: pass (green tick), unknown (grey tick) or fail (red cross).

 

*Known issue:

The VMware ESXi Health PSUs and Sensors Checks may return inaccurate results on HP ProLiant DL servers.