VMware Host Performance (REST & VI/JSON) Sensor | PRTG Manual

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.

VMware Host Performance (REST & VI/JSON) Sensor

VMware Host Performance (REST & VI/JSON) Sensor

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

Sensor in Other Languages

  • 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)

Remarks

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.

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

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.

Basic Sensor Settings

Basic Sensor Settings

Basic Sensor Settings

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

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

Specific 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.

i_round_blueYou cannot change the host that this sensor monitors after sensor creation. If you want to monitor a different host, create the sensor again.

Specific Sensor Settings

Specific Sensor Settings

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.

Sensor Display

Sensor Display

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.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary 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.
    i_round_redYou 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.

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result (default): Do not store the sensor result.
  • Store result: Store the sensor result and the last response in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file name is Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites this file with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

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 b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Channel List

i_round_blueWhich 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

  • Upper error limit: 90%
  • Upper warning limit: 80%

i_round_blueThis channel is the primary channel by default.

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 (%)

  • Upper error limit: 90%
  • Upper warning limit: 80%

Memory Swap Consumed

The memory swap consumed

Network Received

The received bytes

Network Transmitted

The transmitted bytes

System Uptime

The uptime

More

i_square_blueKNOWLEDGE BASE

What security features does PRTG include?