PRTG Manual: VMware Host Hardware Status (SOAP) Sensor

The VMware Host Hardware Status (SOAP) sensor monitors the hardware status of a VMware host server using the Simple Object Access Protocol (SOAP). It gives you a general status overview of the host.

The sensor also shows any states other than normal in the sensor message.

VMware Host Hardware Status (SOAP) Sensor

For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

Dutch: VMware Host Hardware Status (SOAP)
French: VMware statut du matériel du serveur hôte (SOAP)
German: VMware Hostserver Hardware-Zustand (SOAP)
Japanese: VMware ホストハードウェアの状態（SOAP）
Portuguese: Status do hardware de host VMware (SOAP)
Russian: Состояние аппаратных средств узла VMware (SOAP)
Simplified Chinese: VMware 主机硬件状态 (SOAP)
Spanish: Estado de hardware host VMware (SOAP)

Remarks

Consider the following remarks and requirements for this sensor:

Remark	Description
.NET 4.7.2 or later	This sensor requires .NET 4.7.2 or later from Microsoft on the probe system. In a cluster, install it on every cluster node. If the framework is missing, you cannot create this sensor. For more information, see the Knowledge Base: Which .NET version does PRTG require?
Windows Server	We recommend Windows Server 2016 on the probe system for best performance of this sensor.
Credentials	This sensor requires credentials for VMware/XenServer in the settings of the parent device. Enter a user with sufficient access rights to obtain statistics (read-only usually works).
Parent device	This sensor requires that the parent device is a VMware ESXi server as of version 5.2. We recommend that you do not use this sensor on your vCenter. Reliable hardware information can only be provided when this sensor is created on your physical host server as parent device.
IPv6	This sensor supports IPv6.
Performance impact	This sensor has a medium performance impact.
Sensors	This sensor only shows items that report an actual state, so you might see more "sensors" in your vSphere client than the number of states available in the channels of this sensor
Knowledge Base	Knowledge Base: I cannot add VMware sensors because of "wrong" password although it is correct. What can I do? Knowledge Base: Why are my VMware sensors not working after upgrading to VCSA 6.5 U1?

Settings on VMware Host System

If you set up this sensor on different probes (for example, when using remote probes or when running a failover cluster), you might need to change the settings of your VMware host so that it accepts more incoming connections. Otherwise, you might get connection timeouts when running plenty of VMware sensors with a short scanning interval.

For more information, see the Knowledge Base: How can I increase the connection limit on VMware systems? PE121.

Basic Sensor Settings

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

esxserverhosthealthsensor

For more information about basic sensor settings, see section Sensor Settings.

VMware Host Settings

Setting	Description
Managed Object Identifier (MOID)	The managed object identifier of the host that this sensor monitors.
Known Warnings	Enter one or more warning messages from the VMware host that you want to ignore. Use semicolons (;) as separators, for example, Power Supply 7;Power Supply 8. Enter a string or leave the field empty. Warning messages that you enter do not affect the sensor status. We strongly recommend that you use this filter for known issues only. For example, for states that systems return because of errors in the vendors' CIM extensions. Because of this, the sensor might never show the Up status although the vSphere client does not show any warnings.
Known Errors	Enter one or more error messages from the VMware host that you want to ignore. Use semicolons (;) as separators, for example, Power Supply 7;Power Supply 8. Enter a string or leave the field empty. Error messages that you enter do not affect the sensor status. We strongly recommend that you use this filter for known issues only. For example, for states that systems return because of errors in the vendors' CIM extensions. Because of this, the sensor might never show the Up status although the vSphere client does not show any errors.
Handling of Unknown States	Define the sensor behavior when the vSphere client reports unknown states: Show unknown states (default): Show unknown states in the status message and set the sensor to the Warning status. Do not show unknown states: Do not show unknown states in the status message and do not change the sensor status.
Result Handling	Define what PRTG does with the sensor result: Discard result (default): Do not store the sensor result. Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file names are Result of Sensor [ID].txt and Result of Sensor [ID].Data.txt. This setting is for debugging purposes. PRTG overwrites these files with each scanning interval. This option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance. In a cluster, PRTG stores the result in the PRTG data directory of the master node.

Sensor Display

Setting	Description
Primary Channel	Select a channel from the list to define it as the primary channel. In the device tree, PRTG displays the last value of the primary channel below the sensor's name. The available options depend on what channels are available for this sensor. You can set a different primary channel later by clicking below a channel gauge on the sensor's Overview tab.
Graph Type	Define how this sensor shows different channels: Show channels independently (default): Show a graph for each channel. Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic. You cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).
Stack Unit	This setting is only visible if you select Stack channels on top of each other above. Select a unit from the list. PRTG stacks all channels with this unit on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Setting

Description

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, PRTG displays the last value of the primary channel below the sensor's name. The available options depend on what channels are available for this sensor.

You can set a different primary channel later by clicking below a channel gauge on the sensor's Overview tab.

Graph Type

Define how this sensor shows different channels:

Show channels independently (default): Show a graph for each channel.
Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
You cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you select Stack channels on top of each other above.

Select a unit from the list. PRTG stacks all channels with this unit on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Inherited Settings

By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click under the corresponding setting name to disable the inheritance and to display its options.

For more information, see section Inheritance of Settings.

Channel List

Which channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.

Channel	Description
Alert States	The total number of items in the alert status as the vSphere client reports
Downtime	In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status
Normal States	The total number of items in the normal status as the vSphere client reports This channel is the primary channel by default.
Unknown States	The total number of items in the unknown status as the vSphere client reports
Warning States	The total number of items in the warning status as the vSphere client reports