Module jdk.management

Package com.ibm.virtualization.management

Class GuestOSProcessorUsage

java.lang.Object

com.ibm.virtualization.management.GuestOSProcessorUsage

public final class GuestOSProcessorUsage
extends Object

This provides a snapshot of the Guest (Virtual Machine(VM)/Logical Partition(LPAR)) Processor usage statistics as seen by the Hypervisor Host. The statistics are an aggregate across all physical CPUs assigned to the Guest by the Hypervisor Host. The supported Operating System and Hypervisor combinations are:

1. Linux and Windows on VMWare (IBM Java 8 only).
2. AIX and Linux on PowerVM.
3. Linux and z/OS on z/VM.
4. Linux on PowerKVM.

Since:

1.7.1

Constructor Summary

Constructors

Constructor	Description
GuestOSProcessorUsage()	Creates a new GuestOSProcessorUsage instance.

Method Summary

Modifier and Type	Method	Description
static GuestOSProcessorUsage	from(CompositeData cd)	Receives a CompositeData representing a GuestOSProcessorUsage object and attempts to return the root GuestOSProcessorUsage instance.
float	getCpuEntitlement()	The total CPU Entitlement assigned to this Guest by the Hypervisor.
long	getCpuTime()	The total used time of the Guest as reported by the Hypervisor in microseconds.
long	getHostCpuClockSpeed()	The the clock speed of the Host Processor in platform-dependent units.
long	getTimestamp()	The timestamp when the usage statistics were last sampled in microseconds.
String	toString()	Text description of this GuestOSProcessorUsage object.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GuestOSProcessorUsage

public GuestOSProcessorUsage()

Creates a new GuestOSProcessorUsage instance.

Method Detail

getCpuTime

public long getCpuTime()

The total used time of the Guest as reported by the Hypervisor in microseconds.

• z/OS maintains CPU usage history only for the last 4 hours. The value might not be monotonically increasing.

Returns:

used time in microseconds or -1 if info not available.

getHostCpuClockSpeed

public long getHostCpuClockSpeed()

The the clock speed of the Host Processor in platform-dependent units.

• z/OS: Millions of Service Units (MSUs).
• Linux, AIX, and Windows: MegaHertz (MHz).

Returns:

Host CPU clock speed or -1 if not available.

getTimestamp

public long getTimestamp()

The timestamp when the usage statistics were last sampled in microseconds.

Returns:

The last sampling timestamp in microseconds.

getCpuEntitlement

public float getCpuEntitlement()

The total CPU Entitlement assigned to this Guest by the Hypervisor. The value is in Processor units and could be a fraction.

• VMWare: CpuLimitMHz, CpuReservationMHz, CpuShares and HostProcessorSpeed are used to arrive at the Entitlement.
  • See the VMware GuestSDK for more on what these mean.
• PowerVM: entitled_proc_capacity/100 on AIX and partition_entitled_capacity/100 on Linux represents the Entitlement.
  • See perfstat_partition_total interface on AIX.
  • See lparcfg documentation on Linux.
• z/VM: CPU Entitlement is unavailable.

Returns:

CPU Entitlement assigned for this Guest or -1 if not available.

from

public static GuestOSProcessorUsage from(CompositeData cd)

Receives a CompositeData representing a GuestOSProcessorUsage object and attempts to return the root GuestOSProcessorUsage instance.

Parameters:

cd - A CompositeData that represents a GuestOSProcessorUsage.

Returns:

if cd is non- null, returns a new instance of GuestOSProcessorUsage, If cd is null, returns null.

Throws:

IllegalArgumentException - if argument cd does not correspond to a GuestOSProcessorUsage with the following attributes:

• cpuTime(java.lang.Long)
• timestamp(java.lang.Long)
• cpuEntitlement(java.lang.Float)
• hostCpuClockSpeed(java.lang.Long)

toString

public String toString()

Text description of this GuestOSProcessorUsage object.

Overrides:

toString in class Object

Returns:

Text description of this GuestOSProcessorUsage object.