PRTG Manual: VMware Datastore (SOAP) Sensor

The VMware Datastore (SOAP) sensor monitors the disk usage of a VMware datastore using the Simple Object Access Protocol (SOAP).

VMware Datastore (SOAP) Sensor

VMware Datastore (SOAP) 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 Datastore (SOAP)

French: VMware Datastore (SOAP)

German: VMware Datastore (SOAP)

Japanese: VMware Datastore(SOAP)

Portuguese: Armazenamento de dados VMware (SOAP)

Russian: Хранилище данных VMware (SOAP)

Simplified Chinese: VMware 数据存储 (SOAP)

Spanish: Almacén de datos VMware (SOAP)

Remarks

The parent device must be a VMware ESXi server as of version 5.2 or vCenter.

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

This sensor requires .NET 4.7.2 or later from Microsoft on the probe system.

We recommend Windows Server 2012 R2 on the probe system for best performance of this sensor.

This sensor supports the IPv6 protocol.

This sensor has a very low performance impact.

This sensor uses lookups to determine the status values of one or more channels. This means that possible states are defined in a lookup file. You can change the behavior of a channel by editing the lookup file that the channel uses. For details, see section Define Lookups.

This sensor has predefined limits for several metrics. You can individually change these limits in the channel settings. For detailed information about channel limits, see section Channel Settings.

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?

i_round_blueThis sensor supersedes the outdated SSH VMWare ESX(i) Disk sensor. We recommend that you use this new VMware Datastore (SOAP) sensor to monitor VMware datastores.

Detailed Requirements

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

i_round_redIf the framework is missing, you cannot create this sensor.

i_square_cyanFor more information, see the Knowledge Base: 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 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.

i_square_cyanFor details about this setting, see the Knowledge Base: How can I increase the connection limit on VMware systems? PE121.

Add Sensor

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.

i_round_blueThe settings that you select in the Add Sensor dialog are valid for all sensors that you create when you finish the dialog.

Datastore Settings

Setting

Description

Datastore

Select the datastores that you want to monitor. PRTG creates one sensor for each datastore that you select.

i_round_blueEnable check boxes in front of the respective lines to select the items. Use the check box in the table header to select all items or to cancel the selection. In large tables, use the search function in the upper-right corner.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a 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.

i_round_blueIf the name contains angle brackets (<>), PRTG replaces them with braces ({}) for security reasons. For more information, see the Knowledge Base: What security features does PRTG include?

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

i_round_blueThis setting is for your information only. You cannot change it.

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.

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

i_round_blueFor performance reasons, it can take some minutes until you can filter for new tags that you added.

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

vmwaredatastoreexternsensor

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 (i_priority_1) to the highest priority (i_priority_5).

i_round_blueUsually, a sensor connects to the IP Address/DNS Name of the parent device. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings.

Datastore Settings

Datastore Settings

Datastore Settings

Setting

Description

Managed Object Identifier (MOID)

Shows the managed object identifier (MOID) of the datastore that this sensor monitors.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

Result Handling

Define what PRTG does with the sensor result:

Discard result: 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.

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.

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

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 different channels are shown for this sensor:

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

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.

Scanning Interval

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

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

Schedules, Dependencies, and Maintenance Window

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel Unit Configuration

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

Channel Unit Configuration

Channel Unit Configuration

i_square_cyanFor more information, see section Root Group Settings, section Channel Unit Configuration.

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

Accessible

The accessibility of the datastore

Up status: Yes

Down status: No

Available Capacity

The available capacity in bytes (the physically or virtually available size of the datastore)

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

Free Bytes

The free space (the disk space that is not used by virtual machines (VM). Used disk space can be either thick-provisioned or used by thin-provisioned virtual disks)

Free Space

The free space (%) (the disk space that is not used by VMs. Used disk space can be either thick-provisioned or used by thin-provisioned virtual disks)

i_round_blueThis channel is the primary channel by default.

Total Provisioned

The total provisioned disk space in percent (the sum of all potentially used disk space of thin-provisioned and thick-provisioned VM hard drives, that is, the uncommitted bytes plus used bytes)

Uncommitted Bytes

The uncommitted bytes (the disk space that is provisioned for thin-provisioned VMs but not used yet)

More

i_square_blueKNOWLEDGE BASE

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

https://kb.paessler.com/en/topic/66794

Why are my VMware sensors not working after upgrading to VCSA 6.5 U1?

https://kb.paessler.com/en/topic/78274

Which .NET version does PRTG require?

https://kb.paessler.com/en/topic/60543

How can I increase the connection limit on VMware systems? PE121

https://kb.paessler.com/en/topic/30643

What security features does PRTG include?

https://kb.paessler.com/en/topic/61108

Monitoring VMware ESXi 5.5 does not work. What can I do?

https://kb.paessler.com/en/topic/59173

For which sensor types do you recommend at least Windows Server 2012 R2 and why?

https://kb.paessler.com/en/topic/64331