PRTG Manual
VMware Host Performance (REST & VI/JSON) Sensor
The VMware Host Performance (REST & VI/JSON) sensor monitors VMware ESXi host performance metrics using the VMware REST API and Virtual Infrastructure (VI)/JSON API.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: VMware Host Performance (REST & VI/JSON)
- French: VMware Host Performance (REST & VI/JSON)
- German: VMware Host Performance (REST & VI/JSON)
- Japanese: VMware Host Performance (REST & VI/JSON)
- Portuguese: VMware Host Performance (REST & VI/JSON)
- Russian: VMware Host Performance (REST & VI/JSON)
- Simplified Chinese: VMware Host Performance (REST & VI/JSON)
- Spanish: VMware Host Performance (REST & VI/JSON)
Consider the following remarks and requirements for this sensor:
Remark |
Description |
|---|---|
Credentials |
The sensor requires credentials for VMware vSphere in the settings of the parent device. |
Parent device |
This sensor requires a parent device as of vCenter Server 8.0 Update 1. If you set up this sensor on multiple 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 receive connection timeouts and errors when running many VMware sensors with a short scanning interval.
|
Meta-scan |
This sensor uses the meta-scan feature. After sensor creation, some settings might appear for reference purposes only. |
IPv6 |
This sensor supports IPv6. |
Performance impact |
This sensor has a very low performance impact. |
Limits |
This sensor has predefined limits for one or several metrics. |
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
- esxi
- host
- performance
- rest
- vcenter
- vijson
- vmware
- vsphere
For more information about basic sensor settings, see section Sensor Settings.
During sensor creation, PRTG performs a meta-scan of the target device and displays all available ESXi hosts in a table. Select the checkbox next to the host that you want to monitor. PRTG creates one sensor for each host that you select.
You cannot change the host that this sensor monitors after sensor creation. If you want to monitor a different host, create the sensor again.
Setting |
Description |
|---|---|
Display Name |
Shows the display name of the ESXi host that this sensor monitors. |
Host ID |
Shows the ID of the ESXi host that this sensor monitors, as used by the vSphere API. |
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.
|
Graph Type |
Define how this sensor shows different channels:
|
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 |
|---|---|
Result Handling |
Define what PRTG does with the sensor result:
|
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.
Which channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.
Channel |
Description |
|---|---|
Ballooned Memory |
The ballooned memory |
CPU Ready |
The CPU readiness (%) |
CPU Usage |
The CPU usage
|
Disk Device Latency |
The disk device latency |
Disk Read |
The disk read speed |
Disk Read Latency |
The read latency |
Disk Write |
The disk write speed |
Disk Write Latency |
The disk write latency |
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. |
Memory Consumed |
The consumed memory |
Memory Consumed % |
The memory consumed (%)
|
Memory Swap Consumed |
The memory swap consumed |
Network Received |
The received bytes |
Network Transmitted |
The transmitted bytes |
System Uptime |
The uptime |
KNOWLEDGE BASE
What security features does PRTG include?




