java.lang.Object
com.ibm.virtualization.management.internal.GuestOS
- All Implemented Interfaces:
GuestOSMXBean,PlatformManagedObject
Runtime type for
GuestOSMXBean.
Implements retrieving Guest (Virtual Machine(VM)/Logical Partition(LPAR)) Processor and Memory usage statistics from the Hypervisor Host.
- Since:
- 1.7.1
-
Method Summary
Modifier and TypeMethodDescriptionstatic GuestOSSingleton accessor method.Returns the object name of the MXBean.Function instantiates aGuestOSMemoryUsageobject and populates it with the current snapshot of Memory Usage statistics of the Guest as seen by the Hypervisor.retrieveMemoryUsage(GuestOSMemoryUsage gmUsage) Snapshot of the Guest Memory usage statistics as seen by the Hypervisor, returned as aGuestOSMemoryUsageobject.Function instantiates aGuestOSProcessorUsageobject and populates it with the current snapshot of Processor Usage statistics of the Guest as seen by the Hypervisor.Snapshot of the Guest Processor usage statistics as seen by the Hypervisor, returned as aGuestOSProcessorUsageobject.
-
Method Details
-
getInstance
Singleton accessor method.- Returns:
- the
GuestOSsingleton.
-
getObjectName
Returns the object name of the MXBean.- Specified by:
getObjectNamein interfacePlatformManagedObject- Returns:
- objectName representing the MXBean.
-
retrieveProcessorUsage
Function instantiates aGuestOSProcessorUsageobject and populates it with the current snapshot of Processor Usage statistics of the Guest as seen by the Hypervisor. The statistics are an aggregate across all physical CPUs assigned to the Guest by the Hypervisor.- Specified by:
retrieveProcessorUsagein interfaceGuestOSMXBean- Returns:
- The new
GuestOSProcessorUsageobject. - Throws:
GuestOSInfoRetrievalException- if it failed to obtain usage statistics.In case of an exception, the handler code can use toString() on the exception code to obtain a description of the exception.
-
retrieveProcessorUsage
public GuestOSProcessorUsage retrieveProcessorUsage(GuestOSProcessorUsage gpUsage) throws NullPointerException, GuestOSInfoRetrievalException Snapshot of the Guest Processor usage statistics as seen by the Hypervisor, returned as aGuestOSProcessorUsageobject. The statistics are an aggregate across all physical CPUs assigned to the Guest by the Hypervisor.- Specified by:
retrieveProcessorUsagein interfaceGuestOSMXBean- Parameters:
gpUsage- User providedGuestOSProcessorUsageobject.- Returns:
- The updated
GuestOSProcessorUsageobject. - Throws:
NullPointerException- if a null reference is passed.GuestOSInfoRetrievalException- if it failed to obtain usage statistics.In case of an exception, the handler code can use toString() on the exception code to obtain a description of the exception.
-
retrieveMemoryUsage
Function instantiates aGuestOSMemoryUsageobject and populates it with the current snapshot of Memory Usage statistics of the Guest as seen by the Hypervisor.- Specified by:
retrieveMemoryUsagein interfaceGuestOSMXBean- Returns:
- The new
GuestOSMemoryUsageobject. - Throws:
GuestOSInfoRetrievalException- if it failed to obtain usage statistics.In case of an exception, the handler code can use toString() on the exception code to obtain a description of the exception.
-
retrieveMemoryUsage
public GuestOSMemoryUsage retrieveMemoryUsage(GuestOSMemoryUsage gmUsage) throws NullPointerException, GuestOSInfoRetrievalException Snapshot of the Guest Memory usage statistics as seen by the Hypervisor, returned as aGuestOSMemoryUsageobject.- Specified by:
retrieveMemoryUsagein interfaceGuestOSMXBean- Parameters:
gmUsage- User providedGuestOSMemoryUsageobject.- Returns:
- The updated
GuestOSMemoryUsageobject. - Throws:
NullPointerException- if a null reference is passed.GuestOSInfoRetrievalException- if it failed to obtain usage statistics.In case of an exception, the handler code can use toString() on the exception code to obtain a description of the exception.
-