4.38 VmToolsStatus

Use this Knowledge Script to monitor the status of VMware Tools for virtual machines. This script raises an event if VMware Tools have never been installed, are not running, have an outdated version, have a current version, and multiple other status values. The script also generates data streams for VMware Tools status.

NOTE:

  • If the parent host of the monitored virtual machine is in maintenance mode, this Knowledge Script will not generate events.

  • Using this script and other VirtualCenter_Vm* scripts to monitor a large number of virtual machines at the same time might cause the jobs to fail. If the jobs fail on a regular basis, consider running the VirtualCenter_Vm* scripts on fewer virtual machines.

4.38.1 Resource Object

vSphere virtual machine

4.38.2 Default Schedule

By default, this script runs every 1 Day.

4.38.3 Setting Parameter Values

Set the following parameters as needed:

Parameter

How to Set It

General Settings

Job Failure Notification

Event severity when AppManager failed to get metrics

Set the event severity level, from 1 to 40, to indicate the importance of an event in which AppManager failed to retrieve metrics from vCenter. The default is 15.

Event severity when AppManager when failed to log in

Set the event severity level, form 1 to 40, to indicate the importance of an event in which AppManager failed to log in to vCenter. The default is 5.

Event severity when VMToolsStatus job fails unexpectedly

Set the event severity level, form 1 to 40, to indicate the importance of an event in which the VMToolsStatus job fails unexpectedly. The default is 5.

Raise event when status information is not available?

Select Yes to raise an event when information about the virtual machine’s connection status is not available. The default is unselected.

Event severity when status information is not available

Set the event severity level, from 1 to 40, to indicate the importance of an event in which information about the virtual machine’s connection status is not available. The default is 15.

Additional Settings

Event Details

Event detail format

Select either HTML Table or Plain Text as the format for event detail. The default is HTML Table.

Monitor VMware Tools Status

Event Notification

Running Status

Raise event when not installed?

Select Yes to raise an event when VM Tools have not been installed on the virtual machine. The default is Yes.

Event severity when not installed

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VM Tools have not been installed on the virtual machine. The default is 15.

Raise event when not running?

Select Yes to raise an event when VMware Tools are not running on a virtual machine. The default is Yes.

Event severity when not running

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VMware Tools are not running on a virtual machine. The default is 15.

Raise event when not running on powered-off virtual machine?

Select Yes to raise an event when VMware Tools are not running on a powered-off virtual machine. The default is Yes.

Event severity when not running on powered-off virtual machine

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VMware Tools are not running on a powered-off virtual machine. The default is 5.

Version Status

Raise event when blacklisted and needs immediate upgrade?

Select Yes to raise an event when VMware Tools have been blacklisted and need an immediate upgrade. The default is Yes.

Event severity when blacklisted and needs immediate upgrade

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VMware Tools have been blacklisted and need an immediate upgrade. The default is 5.

Raise event when not current and not supported?

Select Yes to raise an event when VMware Tools are so old that they are not current and not supported. The default is Yes.

Event severity when not current and not supported

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VMware Tools are not current and not supported. The default is 10.

Raise event when not current but supported?

Select Yes to raise an event when VMware Tools are not current but supported. The default is Yes.

Event severity when not current but supported

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VMware Tools are not current but supported. The default is 15.

Raise event when not managed by VMware?

Select Yes to raise an event when VMware Tools are not managed by VMware. The default is Yes.

Event severity when not managed by VMware

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VMware Tools are not managed by VMware. The default is 15.

Raise event when supported and newer than version on host

Select Yes to raise an event when VMware Tools are supported, but a newer version than the version on the host. The default is Yes.

Event severity when supported and newer than version on host

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VMware Tools are supported, but a newer version than the version on the host. The default is 15.

Raise event when too new to work correctly?

Select Yes to raise an event when VMware Tools are too new to work correctly with this module. The default is Yes.

Event severity when too new to work correctly

Set the event severity level, from 1 to 40, to indicate the importance of an event in which VMware Tools are too new to work correctly with this module. The default is 10.

Data Collection

Collect data for VMware Tools status?

Select Yes to collect VMware Tools status data for charts and reports. The default is unselected.

NOTE:If selected, the possible values are:

  • 0: VMware Tools are not installed

  • 1: VMware Tools are not running

  • 2: VMware Tools version is old

  • 3: VMware Tools are okay

  • 4: VMware Tools are not running on powered-off virtual machines

  • 5: VMware Tools are blacklisted and need an immediate upgrade

  • 6: VMware Tools are supported and newer than the version on the host

  • 7: VMware Tools are too new

  • 8: VMware Tools are not current and not supported

  • 9: VMware Tools are not managed by VMware