Skip to content
Python API for interacting with VMware's VMGuestLib SDK
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Initial commit Dec 5, 2013
AUTHORS Added initial version and documentation Dec 5, 2013
LICENSE Renamed package like recommended in and added a example of … Nov 3, 2016 Add missing GetResourcePoolPath() functionality Dec 10, 2013 Renamed package like recommended in and added a example of … Nov 3, 2016
vmguest-example Make CloseHandle() clean up the handle, and use it in our examples Dec 11, 2013
vmguest-stats Print out timestamp on each cycle Oct 28, 2015 Corrected method name for Host CPU Used MS (#4) Oct 3, 2016

VMGuestLib python wrapper

Python API for interacting with VMware's VMGuestLib SDK.


The software is easy to install from github:

$ git clone git://
$ cd vmguestlib
$ python install

Quick Example


from vmguestlib import VMGuestLib

gl = VMGuestLib()

print 'CPU'
print '  Stolen: %dms' % gl.GetCpuStolenMs()
print '  Used: %dms' % gl.GetCpuUsedMs()
print '  Elapsed: %dms' % gl.GetElapsedMs()

print 'Memory'
print '  Active: %d MB' % gl.GetMemActiveMB()
print '  Ballooned: %d MB' % gl.GetMemBalloonedMB()
print '  Mapped: %d MB' % gl.GetMemMappedMB()
print '  Overhead: %d MB' % gl.GetMemOverheadMB()
print '  Shared: %d MB' % gl.GetMemSharedMB()
print '  Shared saved: %d MB' % gl.GetMemSharedSavedMB()
print '  Swapped: %d MB' % gl.GetMemSwappedMB()
print '  Used: %d MB' % gl.GetMemUsedMB()


vmguest-stats tool

The vmguestlib package includes a basic vmguest-stats tool to get all vmguestlib counters. It outputs this:

[user@system ~]$ vmguest-stats
VM Processor
    Processor Time: 4.64 %
    CPU stolen time: 0.15 %
    Effective VM Speed: 136 MHz
    Host processor speed: 2932 MHz

    Limit: unlimited
    Reservation: 0 MHz
    Shares: 4000

VM Memory
    Active: 1105 MB
    Ballooned: 0 MB
    Mapped: 12288 MB
    Overhead: 110 MB
    Shared: 69 MB
    Shared Saved: 68 MB
    Swapped: 0 MB
    Target Size: 12219 MB
    Used: 12219 MB

    Limit: unlimited
    Reservation: 0 MB
    Shares: 122880


Tools known to be using vmguestlib:



Please report bugs, improvements and feedback on GitHub at:

Packaging guidelines

Please package this software using the name "python-vmguestlib" on all platforms, and include the vmguest-stats utility as-is.

With python comes a packaging tool: setuptools. Example for rpm:

git clone
cd vmguestlib
python bdist_rpm

Author and license

This software is (c) 2013-2014 Dag Wieers

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

You can’t perform that action at this time.