PRTG Manual: VMware Host Performance (SOAP) Sensor
The VMware Host Performance (SOAP) sensor monitors a VMware host server using the Simple Object Access Protocol (SOAP).
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: VMware Host Prestaties (SOAP)
- French: VMware performances du serveur hôte (SOAP)
- German: VMware Hostserver Leistung (SOAP)
- Japanese: VMware ホストパフォーマンス(SOAP)
- Portuguese: Performance do host VMware (SOAP)
- Russian: Работа узла VMware (SOAP)
- Simplified Chinese: VMware 主机性能 (SOAP)
- Spanish: Rendimiento de host VMware (SOAP)
- This sensor has a very high performance impact. Use it with care. We recommend that you use no more than 50 sensors of this sensor type on each probe.
- This sensor requires Microsoft .NET 4.7.2 or later on the probe system.
- The parent device must be a VMware ESXi server version 5.2 or later. 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.
- This sensor requires credentials for VMware/XenServer in the settings of the parent device. Ensure that you enter a user with sufficient access rights to obtain statistics (read-only usually works).
- We recommend Windows Server 2012 R2 on the probe system for best performance of this sensor.
- This sensor supports the IPv6 protocol.
- See the Knowledge Base: I cannot add VMware sensors because of "wrong" password although it is correct. What can I do?
- See the Knowledge Base: Why are my VMware sensors not working after upgrading to VCSA 6.5 U1?
Requirement |
Description |
---|---|
.NET 4.7.2 or later |
This sensor requires .NET 4.7.2 or later to be installed on the probe system (on every cluster node, if on a cluster probe).
|
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 details about this setting, see the Knowledge Base: How can I increase the connection limit on VMware systems? PE121.
The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.
Click the Settings tab of a sensor to change its settings.
Setting |
Description |
---|---|
Sensor Name |
Enter a name to identify the sensor. |
Parent Tags |
Shows tags that the sensor inherits from its parent device, parent group, and parent probe.
|
Tags |
Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
|
Priority |
Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority ( |
Setting |
Description |
---|---|
Managed Object Identifier (MOID) |
Shows the managed object identifier of the host that this sensor monitors.
|
Result Handling |
Define what PRTG does with the sensor result:
|
Setting |
Description |
---|---|
Primary Channel |
Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.
|
Graph Type |
Define how different channels are shown for this sensor:
|
Stack Unit |
This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked 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. |
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.
For more information, see section Root Group Settings, section Scanning Interval.
Schedules, Dependencies, and Maintenance Window
You cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.
For more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.
For more information, see section Root Group Settings, section Access Rights.
Which channel units are available depends on the sensor type and the available parameters. If no configurable channels are available, this field shows No configurable channels.
For more information, see section Root Group Settings, section Channel Unit Configuration.
Which channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.
Channel |
Description |
---|---|
CPU Ready (Percent) |
The CPU readiness in percent |
CPU Usage |
The CPU usage in percent
|
Datastore Total ReadLatency |
The datastore total read latency in milliseconds (msec) |
Datastore Total WriteLatency |
The datastore total write latency in msec |
Disk Read |
The disk read speed in bytes per second |
Disk Usage |
The disk usage per second |
Disk Write |
The disk write speed in bytes per second |
Disk.DeviceLatency |
The disk device latency in msec |
Disk.KernelLatency |
The disk kernel latency in msec |
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 in percent. |
Memory Active |
The active memory in bytes |
Memory Consumed |
The consumed memory in bytes |
Memory Consumed (Percent) |
The memory consumed in percent |
Memory Swap Used |
The used memory swap |
Network Received |
The received bytes per second |
Network Transmitted |
The transmitted bytes per second |
Network Usage |
The total network usage in bytes per second |
Power |
The average host power usage in watts |
Knowledge Base
I cannot add VMware sensors because of "wrong" password although it is correct. What can I do?
Why are my VMware sensors not working after upgrading to VCSA 6.5 U1?
Which .NET version does PRTG require?
How can I increase the connection limit on VMware systems? PE121
What security features does PRTG include?
Monitoring VMware ESXi 5.5 does not work. What can I do?
For which sensor types do you recommend Windows Server 2012 R2 or later and why?