VMGuestLibInterface (VMware Guest API Java Support Package)

```
public interface VMGuestLibInterface
```
An interface representing the VMware Guest API. Clients of the VMware Guest API should obtain instances of this interface via the open method of the VMGuestLibHandle class. Each interface instance is bound to and backed by an underlying handle. Handles can be closed explicitly using the close method.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the handle associated with this interface instance and free any related resources.
`long`	`getCpuLimitMHz()` Retrieves the maximum processing power in MHz available to the virtual machine.
`long`	`getCpuReservationMHz()` Retrieves the minimum processing power in MHz available to the virtual machine.
`long`	`getCpuShares()` Retrieves the number of CPU shares allocated to the virtual machine.
`java.math.BigInteger`	`getCpuUsedMs()` Retrieves the number of milliseconds during which the virtual machine has been using the CPU.
`java.math.BigInteger`	`getElapsedMs()` Retrieves the number of milliseconds that have passed in real time since the virtual machine started running on the current host system.
`long`	`getHostProcessorSpeed()` Retrieves the speed of the host system's physical CPU in MHz.
`long`	`getMemActiveMB()` Retrieves the estimated amount of memory the virtual machine is actively using.
`long`	`getMemBalloonedMB()` Retrieves the amount of memory that has been reclaimed from this virtual machine via the VMware Memory Balloon mechanism.
`long`	`getMemLimitMB()` Retrieves the maximum amount of memory that is available to the virtual machine.
`long`	`getMemMappedMB()` Retrieves the mapped memory size of this virtual machine.
`long`	`getMemOverheadMB()` Retrieves the amount of overhead memory associated with this virtual machine consumed on the host system.
`long`	`getMemReservationMB()` Retrieves the minimum amount of memory that is available to the virtual machine.
`long`	`getMemSharedMB()` Retrieves the amount of physical memory associated with this virtual machine that is copy-on-write (COW) shared on the host.
`long`	`getMemSharedSavedMB()` Retrieves the estimated amount of physical memory on the host saved from copy-on-write (COW) shared guest physical memory.
`long`	`getMemShares()` Retrieves the number of memory shares allocated to the virtual machine.
`java.math.BigInteger`	`getMemShares64()` Retrieves the number of memory shares allocated to the virtual machine.
`long`	`getMemSwappedMB()` Retrieves the amount of memory associated with this virtual machine that has been swapped by the host system.
`long`	`getMemUsedMB()` Retrieves the estimated amount of physical host memory currently consumed for this virtual machine's physical memory.
`java.lang.String`	`getResourcePoolPath()` Retrieves a string representation of the path to this virtual machine in the resource pool namespace of the host system.
`long`	`getSessionId()` Retrieves the ID for the current session after invoking the updateInfo method.
`void`	`updateInfo()` Refresh the virtual machine information associated with the handle for this interface instance.

- Method Detail
  - updateInfo
```
void updateInfo()
         throws VMGuestLibErrorException
```
    Refresh the virtual machine information associated with the handle for this interface instance. This method can and should be invoked explicitly to ensure subsequent queries return the most current information available.
    
    Throws:
    
    VMGuestLibErrorException - on error during update.
  - getSessionId
```
long getSessionId()
           throws VMGuestLibErrorException
```
    Retrieves the ID for the current session after invoking the updateInfo method. The session ID is opaque and cannot be compared in any meaningful way with the session IDs from any other virtual machines. If the updateInfo method has not been invoked on this interface instance, a VMGuestLibErrorException (VMGUESTLIB_ERROR_NO_INFO) is thrown.
    
    Returns:
    
    sessionID of current session.
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getCpuReservationMHz
```
long getCpuReservationMHz()
                   throws VMGuestLibErrorException
```
    Retrieves the minimum processing power in MHz available to the virtual machine. Assigning a cpuReservationMHz ensures that even as other virtual machines on a single host consume shared processing power, there is still a certain minimum amount for this virtual machine.
    
    Returns:
    
    cpuReservationMHz value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getCpuLimitMHz
```
long getCpuLimitMHz()
             throws VMGuestLibErrorException
```
    Retrieves the maximum processing power in MHz available to the virtual machine. Assigning a cpuLimitMHz ensures that this virtual machine never consumes more than a certain amount of the available processor power. By limiting the amount of processing power consumed, a portion of this shared resource is available to other virtual machines.
    
    Returns:
    
    cpuLimitMHz value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getCpuShares
```
long getCpuShares()
           throws VMGuestLibErrorException
```
    Retrieves the number of CPU shares allocated to the virtual machine.
    
    Returns:
    
    cpuShares value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getCpuUsedMs
```
java.math.BigInteger getCpuUsedMs()
                           throws VMGuestLibErrorException
```
    Retrieves the number of milliseconds during which the virtual machine has been using the CPU. This value is always less than or equal to elapsedMS. This value, in conjunction with elapsedMS, can be used to estimate effective virtual machine CPU speed.
    
    Returns:
    
    cpuUsedMs value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getHostProcessorSpeed
```
long getHostProcessorSpeed()
                    throws VMGuestLibErrorException
```
    Retrieves the speed of the host system's physical CPU in MHz.
    
    Returns:
    
    host processor speed (MHz) value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemReservationMB
```
long getMemReservationMB()
                  throws VMGuestLibErrorException
```
    Retrieves the minimum amount of memory that is available to the virtual machine. Assigning a memReservationMB ensures that even as other virtual machines on a single host consume memory, there is still a certain minimum amount for this virtual machine.
    
    Returns:
    
    memReservationMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemLimitMB
```
long getMemLimitMB()
            throws VMGuestLibErrorException
```
    Retrieves the maximum amount of memory that is available to the virtual machine. Assigning a memLimitMB ensures that this virtual machine never consumes more than a certain amount of the available memory. By limiting the amount of host memory consumed, a portion of this shared resource is available to other virtual machines.
    
    Returns:
    
    memLimitMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemShares
```
long getMemShares()
           throws VMGuestLibErrorException
```
    Retrieves the number of memory shares allocated to the virtual machine. This API throws an exception if the memory shares exceeds the maximum value of 32-bit unsigned integer (0xFFFFFFFF). Therefore, getMemShares64() should be used instead of this API.
    
    Returns:
    
    memShares (32bits) value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemMappedMB
```
long getMemMappedMB()
             throws VMGuestLibErrorException
```
    Retrieves the mapped memory size of this virtual machine. This is the current total amount of guest memory that is backed by physical memory. Note that this number may include pages of memory shared between multiple virtual machines and thus may be an overestimate of the amount of physical host memory "consumed" by this virtual machine.
    
    Returns:
    
    memMappedMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemActiveMB
```
long getMemActiveMB()
             throws VMGuestLibErrorException
```
    Retrieves the estimated amount of memory the virtual machine is actively using. This method returns an estimated working set size for the virtual machine.
    
    Returns:
    
    memActiveMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemOverheadMB
```
long getMemOverheadMB()
               throws VMGuestLibErrorException
```
    Retrieves the amount of overhead memory associated with this virtual machine consumed on the host system.
    
    Returns:
    
    memOverheadMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemBalloonedMB
```
long getMemBalloonedMB()
                throws VMGuestLibErrorException
```
    Retrieves the amount of memory that has been reclaimed from this virtual machine via the VMware Memory Balloon mechanism.
    
    Returns:
    
    memBalloonedMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemSwappedMB
```
long getMemSwappedMB()
              throws VMGuestLibErrorException
```
    Retrieves the amount of memory associated with this virtual machine that has been swapped by the host system.
    
    Returns:
    
    memSwappedMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemSharedMB
```
long getMemSharedMB()
             throws VMGuestLibErrorException
```
    Retrieves the amount of physical memory associated with this virtual machine that is copy-on-write (COW) shared on the host.
    
    Returns:
    
    memSharedMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemSharedSavedMB
```
long getMemSharedSavedMB()
                  throws VMGuestLibErrorException
```
    Retrieves the estimated amount of physical memory on the host saved from copy-on-write (COW) shared guest physical memory.
    
    Returns:
    
    memSharedSavedMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemUsedMB
```
long getMemUsedMB()
           throws VMGuestLibErrorException
```
    Retrieves the estimated amount of physical host memory currently consumed for this virtual machine's physical memory. This is the same as (mapped memory) - (sharedSaved memory).
    
    Returns:
    
    memUsedMB value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getElapsedMs
```
java.math.BigInteger getElapsedMs()
                           throws VMGuestLibErrorException
```
    Retrieves the number of milliseconds that have passed in real time since the virtual machine started running on the current host system. The elapsed time counter is reset any time the virtual machine is powered on, resumed, or migrated via VMotion. This value, in conjunction with cpuUsedMS, can be used to estimate effective virtual machine CPU speed. The cpuUsedMS value is always less than or equal to this value.
    
    Returns:
    
    elapsedMs value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getResourcePoolPath
```
java.lang.String getResourcePoolPath()
                              throws VMGuestLibErrorException
```
    Retrieves a string representation of the path to this virtual machine in the resource pool namespace of the host system.
    
    Returns:
    
    resourcePoolPath value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - getMemShares64
```
java.math.BigInteger getMemShares64()
                             throws VMGuestLibErrorException
```
    Retrieves the number of memory shares allocated to the virtual machine.
    
    Returns:
    
    memShares64 (64bits) value
    
    Throws:
    
    VMGuestLibErrorException - on error.
  - close
```
void close()
    throws VMGuestLibErrorException
```
    Closes the handle associated with this interface instance and free any related resources. Any method invoked on an interface subsequent to calling the close method will result in a VMGuestLibErrorException (VMGUESTLIB_ERROR_INVALID_HANDLE).
    
    Throws:
    
    VMGuestLibErrorException - on error.

Interface VMGuestLibInterface

Method Summary

Method Detail

updateInfo

getSessionId

getCpuReservationMHz

getCpuLimitMHz

getCpuShares

getCpuUsedMs

getHostProcessorSpeed

getMemReservationMB

getMemLimitMB

getMemShares

getMemMappedMB

getMemActiveMB

getMemOverheadMB

getMemBalloonedMB

getMemSwappedMB

getMemSharedMB

getMemSharedSavedMB

getMemUsedMB

getElapsedMs

getResourcePoolPath

getMemShares64

close