Interface GuestOSMXBean

All Superinterfaces:

PlatformManagedObject

All Known Implementing Classes:

GuestOS

public interface GuestOSMXBean
extends PlatformManagedObject

This interface provides Processor and Memory usage statistics of the Guest (Virtual Machine(VM)/Logical Partition(LPAR)) as seen by the Hypervisor Host. Where there are multiple levels of Hypervisor, only the top level Hypervisor information is returned. These are the supported Hypervisor and Guest Operating System combinations:

1. Windows and Linux on VMWare ESXi (IBM Java 8 only).
   • VMware GuestSDK (Generally packaged with VMWare tools) must be installed in the Guest Operating System.
2. AIX and Linux on PowerVM.
3. Linux on PowerKVM.
   • Guest Operating System memory usage statistics are not available on Linux for PowerKVM.
4. z/OS and Linux on z/VM.
   • hypfs filesystem (s390_hypfs) must be mounted on Linux on z/VM. The userid that runs the Java process must have read and write access.

Usage example for the GuestOSMXBean

 
   ...
   try {
	mxbeanName = new ObjectName("com.ibm.virtualization.management:type=GuestOS");
   } catch (MalformedObjectNameException e) {
	// Exception Handling
   }
   try {
	MBeanServer mbeanServer = ManagementFactory.getPlatformMBeanServer();
	if (true != mbeanServer.isRegistered(mxbeanName)) {
	   // GuestOSMXBean not registered
	}
	GuestOSMXBean guestBean = JMX.newMXBeanProxy(mbeanServer, mxbeanName, GuestOSMXBean.class); 
   } catch (Exception e) {
	// Exception Handling
   }
 
 

Since:

1.7.1

Method Summary

Modifier and Type	Method	Description
GuestOSMemoryUsage	retrieveMemoryUsage()	Function instantiates a GuestOSMemoryUsage object and populates it with the current snapshot of Memory Usage statistics of the Guest as seen by the Hypervisor.
GuestOSMemoryUsage	retrieveMemoryUsage(GuestOSMemoryUsage gmUsage)	Snapshot of the Guest Memory usage statistics as seen by the Hypervisor, returned as a GuestOSMemoryUsage object.
GuestOSProcessorUsage	retrieveProcessorUsage()	Function instantiates a GuestOSProcessorUsage object and populates it with the current snapshot of Processor Usage statistics of the Guest as seen by the Hypervisor.
GuestOSProcessorUsage	retrieveProcessorUsage(GuestOSProcessorUsage gpUsage)	Snapshot of the Guest Processor usage statistics as seen by the Hypervisor, returned as a GuestOSProcessorUsage object.

Methods declared in interface java.lang.management.PlatformManagedObject

getObjectName

Method Details

retrieveProcessorUsage

GuestOSProcessorUsage retrieveProcessorUsage(GuestOSProcessorUsage gpUsage)
                                      throws NullPointerException,
GuestOSInfoRetrievalException

Snapshot of the Guest Processor usage statistics as seen by the Hypervisor, returned as a GuestOSProcessorUsage object. The statistics are an aggregate across all physical CPUs assigned to the Guest by the Hypervisor.

Parameters:

gpUsage - User provided GuestOSProcessorUsage 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.

retrieveProcessorUsage

GuestOSProcessorUsage retrieveProcessorUsage()
                                      throws GuestOSInfoRetrievalException

Function instantiates a GuestOSProcessorUsage 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.

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.

retrieveMemoryUsage

GuestOSMemoryUsage retrieveMemoryUsage(GuestOSMemoryUsage gmUsage)
                                throws NullPointerException,
GuestOSInfoRetrievalException

Snapshot of the Guest Memory usage statistics as seen by the Hypervisor, returned as a GuestOSMemoryUsage object.

Parameters:

gmUsage - User provided GuestOSMemoryUsage 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.

retrieveMemoryUsage

GuestOSMemoryUsage retrieveMemoryUsage()
                                throws GuestOSInfoRetrievalException

Function instantiates a GuestOSMemoryUsage object and populates it with the current snapshot of Memory Usage statistics of the Guest as seen by the Hypervisor.

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.