PRTG Manual: VMware Virtual Machine (SOAP) Sensor

The VMware Virtual Machine (SOAP) sensor monitors a virtual machine on a VMware host server using Simple Object Access Protocol (SOAP).

It shows the following:

  • CPU usage in percent
  • CPU ready in percent
  • Active memory in bytes
  • Consumed memory in bytes and percent
  • Disk read and write speed
  • Read and write latency
  • Network usage (total, received, and transmitted bytes per second)

Which channels the sensor actually shows might depend on the monitored device and the sensor setup.

VMware Virtual Machine (SOAP) Sensor

VMware Virtual Machine (SOAP) Sensor

Sensor in Other Languages

Dutch: VMware Virtuele Machine (SOAP), French: Machine virtuelle VMware (SOAP), German: VMware Virtual Machine (SOAP), Japanese: VMware仮想マシン(SOAP), Portuguese: VMware Máquina virtual (SOAP), Russian: Виртуальная машина VMware (SOAP), Simplified Chinese: VMware 虚拟机 (SOAP), Spanish: Máquina virtual VMware (SOAP)

Remarks

  • Requires .NET 4.5 or later to be installed on the probe system.
  • For this sensor type you must define credentials for VMware servers on the device you want to use the sensor on. Ensure you enter a user with sufficient access rights to obtain statistics (read-only usually works).
  • We recommend that you use vCenter as parent device. When the monitored VM changes the host server via vMotion, PRTG can continue monitoring in this case. The sensor can monitor VMware ESXi server version 5.0, 5.1, 5.5, 6.0, or 6.5.
  • We recommend Windows 2012 R2 on the probe system for best performance of this sensor.
  • For VMware virtual machines, disk usage channels are only available as of virtual hardware version 8.
  • Knowledge Base: I cannot add VMware sensors because of "wrong" password although it is correct. What can I do?
  • This sensor type can have a high impact on the performance of your monitoring system. Please use it with care! We recommend that you use no more than 50 sensors of this sensor type on each probe.

Requirement: .NET Framework

icon-toolsThis sensor type requires the Microsoft .NET Framework to be installed on the computer running the PRTG probe, either on the local system (on every node, if on a cluster probe), or on the system running the remote probe. If the framework is missing, you cannot create this sensor.

Required .NET version (with latest update): .NET 4.5, .NET 4.6, or .NET 4.7.

icon-book-bulbFor more information, please see this Knowledge Base article: Which .NET version does PRTG require?

Settings on VMware Host System

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

icon-book-bulbFor details about this setting, see the Knowledge Base: How can I increase the connection limit on VMware systems?

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the setting fields that are required for creating the sensor. Therefore, you will not see all setting fields in this dialog. You can change (nearly) all settings in the sensor's Settings tab later.

icon-i-roundPRTG requests a full list of all virtual machines configured on the device. Because of this, it may take a few seconds before the dialog is loaded.

Select the VMware virtual machines you want to monitor. PRTG will create one sensor for each virtual machine you choose in the Add Sensor dialog. The settings you choose will be valid for all sensors that you create when you finish this dialog.

The following settings for this sensor differ in the Add Sensor dialog in comparison to the sensor's settings page.

Virtual Machine Settings

Virtual Machine

You see a list of all virtual machines (VMs) available on the host server on this device, including the ones that are not running. All VMs are listed by name and the OS they are running on.

Select the desired items by adding check marks in front of the respective lines. One sensor will be created for each selection. You can also use the check box in the table head to select and deselect all items.

Sensor Settings

On the details page of a sensor, click the Settings tab to change its settings.

icon-i-roundUsually, a sensor connects to the IP Address or DNS Name of the parent device where you created this sensor. See the Device Settings for details. For some sensor types, you can define the monitoring target explicitly in the sensor settings. Please see below for details on available settings.

Basic Sensor Settings

Sensor Name

Enter a meaningful name to identify the sensor. By default, PRTG shows this name in the device tree, as well as in alarms, logs, notifications, reports, maps, libraries, and tickets.

Parent Tags

Shows Tags that this sensor inherits from its parent device, group, and probe. This setting is shown for your information only and cannot be changed here.

Tags

Enter one or more Tags, separated by spaces or commas. You can use tags to group sensors and use tag–filtered views later on. Tags are not case sensitive. We recommend that you use the default value.

You can add additional tags to the sensor if you like. Other tags are automatically inherited from objects further up in the device tree. These are visible above as Parent Tags.

icon-i-roundIt is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with round parentheses (()) or angle brackets (<>).

Priority

Select a priority for the sensor. This setting determines where the sensor is placed in sensor lists. Top priority is at the top of a list. Choose from one star (low priority) to five stars (top priority).

VMware Virtual Machine Settings

MoID

Shows the Managed Object ID (MoID) of the virtual machine that this sensor monitors. Once a sensor is created, you cannot change this value. It is shown for reference purposes only. If you need to change this, please add the sensor anew.

Handling of "Powered Off" VM

Define the sensor behavior for a virtual machine that is powered off. Choose between:

  • Ignore "powered off" state (default): The sensor will not change to a Down status if the virtual machine is powered off. It will report zero values instead.
  • Alarm when VM is "powered off": The sensor will change to a Down status if the virtual machine is powered off.
    icon-i-blueWhile in Down status, a sensor does not record any data in any of its channels.

Debug Options

Sensor Result

Define what PRTG will do with the sensor results. Choose between:

  • Discard sensor result: Do not store the sensor result.
  • Write sensor result to disk (Filename: "Result of Sensor [ID].txt"): Store the last result received from the sensor to the Logs (Sensor) directory in the PRTG data folder on the probe system the sensor is running on (on the Master node if in a cluster). File names: Result of Sensor [ID].txt and Result of Sensor [ID].Data.txt. This is for debugging purposes. PRTG overwrites these files with each scanning interval.
    icon-book-arrowsFor more information on how to find the folder used for storage, see section Data Storage.

icon-prtg-on-demandThis option is not available when the sensor runs on the Hosted Probe of a PRTG hosted by Paessler instance.

Sensor Display

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 will always be displayed below the sensor's name. The available options depend on what channels are available for this sensor.

icon-i-roundYou can set another primary channel later by clicking the pin symbol of a channel in the sensor's Overview tab.

Graph Type

Define how different channels will be shown for this sensor.

  • Show channels independently (default): Show an own 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 will generate an easy-to-read graph that visualizes the different components of your total traffic.
    icon-i-roundThis option cannot be used in combination with manual Vertical Axis Scaling (available in the Sensor Channels Settings settings).

Stack Unit

This setting is only available if stacked graphs are selected above. Choose a unit from the list. All channels with this unit will be 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.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should be changed there, if necessary. Often, best practice is to change them centrally in the Root group's settings, see section Inheritance of Settings for more information. To change a setting only for this object, disable inheritance by clicking the button next to inherit from under the corresponding setting name. You will then see the options described below.

Scanning Interval

Click inherited_settings_button to disrupt the inheritance. See section Inheritance of Settings for more information.

Scanning Interval

Select a scanning interval (seconds, minutes, or hours) from the list. The scanning interval determines the time the sensor waits between two scans. You can change the available intervals in the system administration on PRTG on premises installations.

If a Sensor Query Fails

Define the number of scanning intervals that a sensor has time to reach and check a device again in case a sensor query fails. The sensor can try to re-reach and check a device several times, depending on the option you select here, before it will be set to a Down status. This helps you avoid false alarms if the monitored device has only temporary issues. For previous scanning intervals with failed requests, the sensor will show a Warning status. Choose between:

  • Set sensor to "down" immediately: The sensor will show an error immediately after the first failed request.
  • Set sensor to "warning" for 1 interval, then set to "down" (recommended): After the first failed request, the sensor will show a yellow warning status. If the following request also fails, the sensor will show an error.
  • Set sensor to "warning" for 2 intervals, then set to "down": Show an error status only after three consecutively failed requests.
  • Set sensor to "warning" for 3 intervals, then set to "down": Show an error status only after four consecutively failed requests.
  • Set sensor to "warning" for 4 intervals, then set to "down": Show an error status only after five consecutively failed requests.
  • Set sensor to "warning" for 5 intervals, then set to "down": Show an error status only after six consecutively failed requests.

icon-i-roundSensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval until they show an error. It is not possible to set a WMI sensor to "down" immediately, so the first option will not apply to these sensor types. All other options can apply.

icon-i-roundIf a sensor has defined error limits for channels, it will always show a Down status immediately, so no "wait" option will apply.
 

icon-i-roundIf a channel uses lookup values, it will always show a Down status immediately, so no "wait" options will apply.

Schedules, Dependencies, and Maintenance Window

icon-i-roundInheritance for schedules, dependencies, and maintenance windows cannot be interrupted. The corresponding settings from the parent objects will always be active. However, you can define additional settings here. They will be active at the same time as the parent objects' settings.

Schedule

Select a schedule from the list. Schedules can be used to monitor for a certain time span (days, hours) every week. With the period list option it is also possible to pause monitoring for a specific time span. You can create new schedules and edit existing ones in the account settings.

icon-i-roundSchedules are generally inherited. New schedules will be added to existing ones, so all schedules are active at the same time.

Maintenance Window

Specify if you want to set up a one-time maintenance window. During a "maintenance window" period, this object and all child objects will not be monitored. They will be in a paused state instead. Choose between:

  • Not set (monitor continuously): No maintenance window will be set and monitoring will always be active.
  • Set up a one-time maintenance window: Pause monitoring within a maintenance window. You can define a time span for a monitoring pause below and change it even for a currently running maintenance window.

icon-i-roundTo terminate a current maintenance window before the defined end date, change the time entry in Maintenance Ends field to a date in the past.

Maintenance Begins

This field is only visible if you enabled the maintenance window above. Use the date time picker to enter the start date and time of the maintenance window.

Maintenance Ends

This field is only visible if you enabled the maintenance window above. Use the date time picker to enter the end date and time of the maintenance window.

Dependency Type

Define a dependency type. Dependencies can be used to pause monitoring for an object depending on the status of another. You can choose between:

  • Use parent: Pause the current sensor if the device, where it is created on, is in Down status, or is paused by another dependency.
  • Select object: Pause the current sensor if the device, where it is created on, is in Down status, or is paused by another dependency. Additionally, pause the current sensor if a specific other object in the device tree is in Down status, or is paused by another dependency. Select below.
  • Master object for parent: Make this sensor the master object for its parent device. The sensor will influence the behavior of the device, where it is created on: If the sensor is in Down status, the device will be paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor will be paused if the parent group of its parent device is in Down status, or if it is paused by another dependency.

icon-i-roundTesting your dependencies is easy! Simply choose Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later all dependent objects should be paused. You can check all dependencies in your PRTG installation by selecting Devices | Dependencies from the main menu bar.

Dependency

This field is only visible if the Select object option is enabled above. Click on the reading-glasses and use the object selector to choose an object on which the current sensor will depend.

Dependency Delay (Sec.)

Define a time span in seconds for a dependency delay. After the master object for this dependency goes back to Up status, PRTG will start monitoring the depending objects after this extra delayed. This can help to avoid false alarms, for example, after a server restart, by giving systems more time for all services to start up. Please enter an integer value.

icon-i-round-redThis setting is not available if you choose this sensor to Use parent or to be the Master object for parent. In this case, please define delays in the parent Device Settings or in the superior Group Settings.

Access Rights

Click inherited_settings_button to disrupt the inheritance. See section Inheritance of Settings for more information.

User Group Access

Define which user group(s) will have access to the object you're editing. A table with user groups and types of access rights is shown: It contains all user groups from your setup. For each user group, you can choose from the following access rights:

  • Inherited: Use the access rights settings of the parent object.
  • None: Users in this group cannot see or edit the object. The object neither shows up in lists nor in the device tree. Exception: If a child object is visible to the user, the object is visible in the device tree, though not accessible.
  • Read: Users in this group can see the object and review its monitoring results.
  • Write: Users in this group can see the object, review its monitoring results, and edit the object's settings. They cannot edit access rights settings.
  • Full: Users in this group can see the object, review its monitoring results, edit the object's settings, and edit access rights settings.

You can create new user groups in the System Administration—User Groups settings. To automatically set all objects further down in the hierarchy to inherit this object's access rights, set a check mark for the Revert children's access rights to inherited option.

icon-book-arrowsFor more details on access rights, see the section User Access Rights.

More

Knowledge Base: How can I increase the connection limit on VMware systems?

Knowledge Base: Monitoring ESXi 5.1 and higher: Handshake Failure on Windows XP/Server 2003

Knowledge Base: For which sensor types do you recommend Windows Server 2012 R2 and why?

Knowledge Base: I cannot add VMware sensors because of "wrong" password although it is correct. What can I do?

Knowledge Base: Which .NET version does PRTG require?

Edit Sensor Channels

To change display settings, spike filter, and limits, switch to the sensor's Overview tab and click the gear icon of a specific channel. For detailed information, see the Sensor Channels Settings section.

Notifications

Click the Notification Triggers tab to change notification triggers. For detailed information, see the Sensor Notification Triggers Settings section.

Others

For more general information about settings, see the Object Settings section.

Sensor Settings Overview

For information about sensor settings, see the following sections: