Class GuestOS
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 GuestOS
Singleton accessor method.Returns the object name of the MXBean.Function instantiates aGuestOSMemoryUsage
object 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 aGuestOSMemoryUsage
object.Function instantiates aGuestOSProcessorUsage
object 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 aGuestOSProcessorUsage
object.
-
Method Details
-
getInstance
-
getObjectName
Returns the object name of the MXBean.- Specified by:
getObjectName
in interfacePlatformManagedObject
- Returns:
- objectName representing the MXBean.
-
retrieveProcessorUsage
Function instantiates aGuestOSProcessorUsage
object 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:
retrieveProcessorUsage
in interfaceGuestOSMXBean
- Returns:
- The new
GuestOSProcessorUsage
object. - 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 aGuestOSProcessorUsage
object. The statistics are an aggregate across all physical CPUs assigned to the Guest by the Hypervisor.- Specified by:
retrieveProcessorUsage
in interfaceGuestOSMXBean
- Parameters:
gpUsage
- User providedGuestOSProcessorUsage
object.- Returns:
- The updated
GuestOSProcessorUsage
object. - 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 aGuestOSMemoryUsage
object and populates it with the current snapshot of Memory Usage statistics of the Guest as seen by the Hypervisor.- Specified by:
retrieveMemoryUsage
in interfaceGuestOSMXBean
- Returns:
- The new
GuestOSMemoryUsage
object. - 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 aGuestOSMemoryUsage
object.- Specified by:
retrieveMemoryUsage
in interfaceGuestOSMXBean
- Parameters:
gmUsage
- User providedGuestOSMemoryUsage
object.- Returns:
- The updated
GuestOSMemoryUsage
object. - 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.
-