vSphere provides the PropertyCollector service for accessing data and monitoring changes. Use the RetrievePropertiesEx to obtain values of managed object properties, and WaitForUpdatesEx to monitor and retrieve modified property values.
What to read next
Introduction to the PropertyCollector The PropertyCollector service provides a way to monitor and retrieve information about managed objects, such as whether a host in a cluster is offline, or whether a virtual machine is powered on.
vSphere Data Objects for Property Collection PropertyCollector data objects are used to specify objects and properties for the collector to retrieve.
vSphere Methods for Property Collection The PropertyCollector supports the following approaches to obtaining objects and properties from the server:
Using the PropertyCollector with RetrievePropertiesEx Two use cases show how to retrieve properties of selected managed objects with the RetrievePropertiesEx method.
Retrieve a Property from a Specified Managed Object This procedure uses PropertyCollector to retrieve a property from a single VirtualMachine object with the RetrievePropertiesEx method, by obtaining a managed object reference to the parent object of the VirtualMachine in the inventory.
Retrieve Properties from a Set of Managed Objects with a View This procedure uses PropertyCollector with a ContainerView to retrieve properties from multiple VirtualMachine objects with the RetrieveProperiesEx method.
Property Collector Program in Java for Web Services SDK PropertyCollector provides a powerful, flexible, and efficient way to collect data from a vCenter Server or ESXi host.
Inventory Traversal PropertyCollector can traverse the server inventory in arbitrary ways, enabling you to follow links between related objects.
Client Data Synchronization with WaitForUpdatesEx To maintain a client-side representation of server object state (by monitoring the properties for the inventory), use the CreateFilter and WaitForUpdatesEx methods. WaitForUpdatesEx supports an incremental retrieval model.
Server Data Transmission Property collection can involve the retrieval of large amounts of data, depending on the number of properties implied in the collection request. The server supports segmented data transmission, or chunking, when it sends collected data to a client. If the amount of collected data exceeds the chunk size, the server returns a chunk of data in a single response, and indicates additional data can be retrieved.
PropertyCollector Performance Various factors affect the performance of a PropertyCollector for any given session.
SearchIndex The SearchIndex managed object provides a set of methods to retrieve references to managed objects in the vSphere inventory. You can search by managed objects inventory path, IP address, datastore path, DNS name, and various other identifying attributes.