vmware-cli.py

#!/usr/bin/env jython

import getpass
from java.net  import URL
from java.lang import System
from optparse import OptionParser, OptionGroup, SUPPRESS_HELP
from com.vmware.vim25 import VirtualMachineCapability
from com.vmware.vim25 import VirtualMachineConfigInfo
from com.vmware.vim25 import VirtualMachineConfigSpec
from com.vmware.vim25 import VirtualMachineFileInfo
from com.vmware.vim25 import VirtualDeviceConfigSpec
from com.vmware.vim25 import VirtualDeviceConfigSpecOperation
from com.vmware.vim25 import VirtualDeviceConfigSpecFileOperation
from com.vmware.vim25 import VirtualLsiLogicSASController
from com.vmware.vim25 import VirtualSCSISharing
from com.vmware.vim25 import VirtualDisk
from com.vmware.vim25 import VirtualDiskFlatVer2BackingInfo
from com.vmware.vim25 import VirtualE1000
from com.vmware.vim25 import VirtualEthernetCardNetworkBackingInfo
from com.vmware.vim25 import Description
from com.vmware.vim25 import OptionValue
from com.vmware.vim25.mo import Folder
from com.vmware.vim25.mo import InventoryNavigator
from com.vmware.vim25.mo import ManagedEntity
from com.vmware.vim25.mo import ServiceInstance
from com.vmware.vim25.mo import VirtualMachine
from com.vmware.vim25.mo import HostSystem
from com.vmware.vim25.mo import HostAutoStartManager
from com.vmware.vim25.mo import Datacenter
from com.vmware.vim25.mo import ResourcePool

def getServiceInstance(svr,user,passwd,skipSSL):
    """ 
    Connect to ESX and return service instance
    """
    url = URL("https://%s/sdk" % svr)
    si = ServiceInstance(url,user,passwd,skipSSL)
    return si

def getDatacenters(si):
    """
    Return a list of datacenter managed objects
    """
    dcList = InventoryNavigator(si.getRootFolder()).searchManagedEntities("Datacenter")
    return dcList

def getHostSystems(si):
    """
    Return a list of all host systems in the inventory
    """
    hsList = InventoryNavigator(si.getRootFolder()).searchManagedEntities("HostSystem")
    return hsList

def getResourcePools(si):
    """
    Return a list of resource pool managed objects
    """
    rpList = InventoryNavigator(si.getRootFolder()).searchManagedEntities("ResourcePool")
    return rpList

def getVirtualMachines(si):
    """
    Return a list of all virtual machines in the inventory
    """
    vmList = InventoryNavigator(si.getRootFolder()).searchManagedEntities("VirtualMachine")
    return vmList

def getVirtualMachineByName(si,vmname):
    """
    Return virtual machine with a given name
    """
    vmList = []
    for vm in getVirtualMachines(si):
        if vmname == vm.getName():
            vmList.append(vm)

    if len(vmList) > 1:
        print "Multiple virtual machines named %s.  Please lookup by UUID." % vmname
        return None
    else:
        return vmList[0]

def getVirtualMachineByUUID(si,vmuuid):
    """
    Return virtual machine with a given uuid
    """
    for vm in getVirtualMachines(si):
        if vmuuid == vm.getConfig().uuid:
            return vm
    return None

def listVirtualMachines(vms):
    """
    Print each virtual machine's configuration
    """
    FORMAT = '%-22s %-36s %-38s %-3s %-10s %-20s %-4s'
    print FORMAT % ('VM Name', 'UUID', 'OS Full Name', 'CPU', 'MEM', 'Annotation', 'Power')
    print FORMAT % ('=' * 22, '=' * 36, '=' * 38, '=' * 3, '=' * 10, '=' * 20, '=' * 4) 

    if isinstance(vms, VirtualMachine):
        if "PowerOnVM_Task" in vms.getDisabledMethod():
            state = "ON"
        else:
            state = "OFF"
        print FORMAT % (vms.getName(),vms.getConfig().uuid,vms.getConfig().getGuestFullName(),
                        vms.getConfig().hardware.numCPU,vms.getConfig().hardware.memoryMB,
                        vms.getConfig().annotation,state)
    else:
        for vm in vms:
            if "PowerOnVM_Task" in vm.getDisabledMethod():
                state = "ON"
            else:
                state = "OFF"
            print FORMAT % (vm.getName(),vm.getConfig().uuid,vm.getConfig().getGuestFullName(),
                            vm.getConfig().hardware.numCPU,vm.getConfig().hardware.memoryMB,
                            vm.getConfig().annotation,state)

def listHostSystems(hss):
    """
    Print each esx(i) instance's configuration
    """   
    FORMAT = '%-22s'
    print FORMAT % ('ESX Name')
    print FORMAT % ('=' * 22)

    if isinstance(hss, HostSystem):
        print FORMAT % (hss.getName())
    else:
        for hs in hss:
            print FORMAT % (hs.getName())

def listDatacenters(dcs):
    """
    Print each virtual datacenter's configuration
    """
    FORMAT = '%-22s'
    print FORMAT % ('Datacenter')
    print FORMAT % ('=' * 22) 

    if isinstance(dcs, Datacenter):
        print dcs.getName()
    else:
        for dc in dcs:
            print dc.getName()

def listResourcePools(rps):
    """
    Print each resource pool's configuration
    """
    FORMAT = '%-22s'
    print FORMAT % ('Resource Pool')
    print FORMAT % ('=' * 22)

    if isinstance(rps, ResourcePool):
        print rps.getName()
    else:
        for rp in rps:
            print rp.getName()

def deleteVm(vm):
    """
    Delete given virtual machine
    """
    vmname = vm.getName()
    if "PowerOnVM_Task" in vm.getDisabledMethod():
        powerOffVm(vm)
        
    task = vm.destroy_Task()
    if task.waitForMe() == "success":
        print "%s has been deleted" % (vmname)
    else:
        print "%s could not be deleted" % (vmname)

def powerOnVm(vm):
    """ 
    Power on virtual machine
    """
    if "PowerOnVM_Task" in vm.getDisabledMethod():
        print "%s is already powered ON" % vm.getName()
    else:
        task = vm.powerOnVM_Task(None)
        if task.waitForMe() == "success":
            print "%s is being powered ON" % vm.getName()
        else:
            print "%s could not be powered ON" % vm.getName()

def powerOffVm(vm):
    """
    Power off virtual machine
    """
    if "PowerOffVM_Task" in vm.getDisabledMethod():
        print "%s is already powered OFF" % vm.getName()
    else:
        task = vm.powerOffVM_Task()
        if task.waitForMe() == "success":
            print "%s is being powered OFF" % vm.getName()
        else:
            print "%s could not be powered OFF" % vm.getName()

def resetVm(vm):
    """
    Reset virtual machine power
    """
    if "ResetVM_Task" in vm.getDisabledMethod():
        print "%s can not be reset" % vm.getName()
    else:
        task = vm.resetVM_Task()
        if task.waitForMe() == "success":
            print "%s is being reset" % vm.getName()
        else:
            print "%s could not be reset" % vm.getName()

def powerOnAllVms(vms):
    """
    Power on all virtual machines in a given sequence
    """
    for vm in vms:
        powerOnVm(vm)

def powerOffAllVms(vms):
    """
    Power off all virtual machines in a given sequence
    """
    for vm in vms:
        powerOffVm(vm)

def resetAllVms(vms):
    """
    Reset virtual machine power and return success
    """
    for vm in vms:
        resetVm(vm)

def createScsiSpec(scsiKey,busNumber):
    """
    Define a virtual scsi ctrl spec
    """
    scsiSpec = VirtualDeviceConfigSpec()
    scsiSpec.setOperation(VirtualDeviceConfigSpecOperation.add)
    scsiCtrl = VirtualLsiLogicSASController()
    scsiCtrl.setKey(scsiKey)
    scsiCtrl.setBusNumber(busNumber)
    scsiCtrl.setSharedBus(VirtualSCSISharing.noSharing)
    scsiSpec.setDevice(scsiCtrl)

    return scsiSpec

def createDiskSpec(scsiKey,diskKey,unitNumber,diskSize,diskMode,datastore):
    """
    Define a virtual disk spec
    """
    diskSpec = VirtualDeviceConfigSpec()
    diskSpec.setOperation(VirtualDeviceConfigSpecOperation.add)
    diskSpec.setFileOperation(VirtualDeviceConfigSpecFileOperation.create)
    vd = VirtualDisk()
    vd.setKey(diskKey)
    vd.setCapacityInKB(diskSize)
    vd.setUnitNumber(unitNumber)
    vd.setControllerKey(scsiKey)
    diskfileBacking = VirtualDiskFlatVer2BackingInfo()
    fileName = "["+datastore+"]"
    diskfileBacking.setFileName(fileName)
    diskfileBacking.setDiskMode(diskMode)
    diskfileBacking.setThinProvisioned(True)
    vd.setBacking(diskfileBacking)
    diskSpec.setDevice(vd)

    return diskSpec

def createNicSpec(nicKey,netName,macAddress):
    """
    Define a virtual nic spec
    """
    nicSpec = VirtualDeviceConfigSpec()
    nicSpec.setOperation(VirtualDeviceConfigSpecOperation.add)
    nicBacking = VirtualEthernetCardNetworkBackingInfo()
    # Assign Portgroup
    nicBacking.setDeviceName(netName)
    nic = VirtualE1000()
    nic.setKey(nicKey)
    nic.setBacking(nicBacking)
    # Address type is one of the following "generated", "manual", "assigned" by VC
    if macAddress:
        nic.setAddressType("manual")
        # MacAddress format is not validated here.
        nic.setMacAddress(macAddress)
    else:
        nic.setAddressType("generated")
    nicSpec.setDevice(nic)

    return nicSpec

def createVmSpec(name,cpucount,memorysize,guestos,annotation,datastore,configSpecs):
    """
    Create virtual machine from specs
    """
    # Create vm spec
    vmSpec = VirtualMachineConfigSpec()
    vmSpec.setName(name)
    vmSpec.setNumCPUs(cpucount)
    vmSpec.setMemoryMB(memorysize)
    vmSpec.setGuestId(guestos)
    vmSpec.setAnnotation(annotation)
    bootOrder = OptionValue()
    bootOrder.setKey("bios.bootDeviceClasses")
    bootOrder.setValue("allow:net,cd,hd")
    vmSpec.extraConfig = [bootOrder]
    vmSpec.setDeviceChange(configSpecs)

    # Create file info for the vmx file
    vmfi = VirtualMachineFileInfo()
    vmfi.setVmPathName("["+datastore+"]")
    vmSpec.setFiles(vmfi)

    return vmSpec

def getCommandLineOpts():
    """
    Parses command line options

    @returns: 3-tuple of (parser, options, args)
    """
    parser = OptionParser(version="%prog 1.0", description='VMware Command Line Interface', prog='vmware-cli.py')

    # Virtual Machine Config Defaults
    parser.set_defaults(skipSSL=True)
    parser.set_defaults(cpucount=2)
    parser.set_defaults(memorysize=2048)
    parser.set_defaults(guestos='rhel5_64Guest')
    parser.set_defaults(annotation='')
    parser.set_defaults(datastore='Storage1')

    # Hypervisor Config Options

    # Required Options
    parser.add_option('-s', '--server',   dest='server',        action='store',      help='VMware hypervisor')
    parser.add_option('-u', '--username', dest='username',      action='store',      help='VMware hypervisor username')
    parser.add_option('-p', '--password', dest='password',      action='store',      help='VMware hypervisor password')

    # Managed Objects
    parser.add_option('-D',               dest='datacenter',    action='store_true', help='Datacenter managed object')
    parser.add_option('-H',               dest='host',          action='store_true', help='Host managed object')
    parser.add_option('-V',               dest='vm',            action='store_true', help='Virtual machine managed object')
    parser.add_option('-R',               dest='resource',      action='store_true', help='Resource Pool managed object')
    parser.add_option('-P',               dest='power',         action='store_true', help='Power state')
    parser.add_option('-T',               dest='time',          action='store_true', help='Time state')
    parser.add_option('-L',               dest='license',       action='store_true', help='License state')

    # Actions
    parser.add_option('-q', '--query',    dest='query',         action='store_true', help='Query')
    parser.add_option('-d', '--delete',   dest='delete',        action='store_true', help='Delete')
    parser.add_option('-c', '--create',   dest='create',        action='store_true', help='Create')
    parser.add_option('-m', '--modify',   dest='modify',        action='store_true', help='Modify')

    # Filters
    parser.add_option('--all',            dest='all',           action='store_true', help='Select all')
    parser.add_option('--name',           dest='name',          action='store',      help='Select by name')
    parser.add_option('--uuid',           dest='uuid',          action='store',      help='Select by uuid')
    
    # Power Settings
    parser.add_option('--on',             dest='on',            action='store_true', help='Set Power On')
    parser.add_option('--off',            dest='off',           action='store_true', help='Set Power Off')
    parser.add_option('--reset',          dest='reset',         action='store_true', help='Set Power Reset')

    # Virtual Machine Config Options
    parser.add_option('--cpu-count',      dest='cpucount',      action='store',      help="Number of virtual CPU's (default: 2)", type="int")
    parser.add_option('--memory-size',    dest='memorysize',    action='store',      help='Amount of RAM in MB (default: 2048)',  type="int")
    parser.add_option('--guest-os',       dest='guestos',       action='store',      help='Guest OS short name rhel5_64Guest, freebsd64Guest, solaris10_64Guest (default: rhel5_64Guest)')
    parser.add_option('--notes',          dest='annotation',    action='store',      help='Virtual Machine annotations (default: blank)')
    parser.add_option('--disk',           dest='disk',          action='append',     help='Virtual disk size in Kb.',                                  nargs=1, metavar="<size>")
    parser.add_option('--nic',            dest='nic',           action='append',     help='MAC address (manually assigned or the string "generated")', nargs=2, metavar="<port group> <mac address>")
    parser.add_option('--datastore',      dest='datastore',     action='store',      help='Datastore name (default: Storage1)')

    options, args = parser.parse_args()
    
    return parser, options, args

def main():

    parser, options, args = getCommandLineOpts()

    # Check command line options
    if options.server is None:
        parser.error("You must provide a server")

    username = options.username                 or \
               System.getenv('VMWARE_USERNAME') or \
               System.getProperty('user.name')
    
    if username is None:
        parser.error("You must provide a username")

    password = options.password or \
               System.getenv('VMWARE_PASSWORD')

    if password is None:
        password = getpass.getpass('Enter password for %s: ' % username)

    if (options.name and options.uuid):
        parser.error("A single filter must be specified at a time")
        
    if options.query and (options.delete or options.create or options.modify):
        parser.error("A single action must be specified at a time")
    if options.delete and (options.query or options.create or options.modify):
        parser.error("A single action must be specified at a time")
    if options.create and (options.query or options.delete or options.modify):
        parser.error("A single action must be specified at a time")
    if options.modify and (options.query or options.create or options.delete):
        parser.error("A single action must be specified at a time")
    
    # Get esx service instance
    si = getServiceInstance(options.server,username,password,options.skipSSL)

    # Query Datacenter
    if options.query and options.datacenter:
        dcs = getDatacenters(si)
        if dcs:
            listDatacenters(dcs)

    # Query Host Systems
    if options.query and options.host:
        hss = getHostSystems(si)
        if hss:
            listHostSystems(hss)

    # Query Resource Pools
    if options.query and options.resource:
        rps = getResourcePools(si)
        if rps:
            listResourcePools(rps)

    # Query Virtual Machine by name
    if options.query and options.name and options.vm:
        vm = getVirtualMachineByName(si,options.name)
        if vm:
            listVirtualMachines(vm)
    # Query Virtual Machine by uuid
    elif options.query and options.uuid and options.vm:
        vm = getVirtualMachineByUUID(si,options.uuid)
        if vm:
            listVirtualMachines(vm)
    # Query all Virtual Machines
    elif options.query and options.vm:
        vms = getVirtualMachines(si)
        if vms:
            listVirtualMachines(vms)

    # Modify Virtual Machine power state by name
    if options.name and options.power and options.modify:
        vm = getVirtualMachineByName(si,options.name)
        if vm:
            if options.reset:
                resetVm(vm)
            elif options.off:
                powerOffVm(vm)
            elif options.on:
                powerOnVm(vm)
    # Modify Virtual Machine power state by uuid
    elif options.uuid and options.power and options.modify:
        vm = getVirtualMachineByUUID(si,options.uuid)
        if vm:
            if options.reset:
                resetVm(vm)
            elif options.off:
                powerOffVm(vm)
            elif options.on:
                powerOnVm(vm)
    # Modify power state for all Virual Machines on a host
    elif options.all and options.power and options.modify:
        vms = getVirtualMachines(si)
        if vms:
            if options.reset:
                resetAllVms(vms)
            elif options.off:
                powerOffAllVms(vms)
            elif options.on:
                powerOnAllVms(vms)

    # Delete VMs
    if options.name and options.delete and options.vm:
        vm = getVirtualMachineByName(si,options.name)
        if vm:
            deleteVm(vm)
    elif options.uuid and options.delete and options.vm:
        vm = getVirtualMachineByUUID(si,options.uuid)
        if vm:
            deleteVm(vm)

    # Create VMs
    if options.create and options.vm:
        resourcePool = getResourcePools(si)[0]
        datacenter = getDatacenters(si)[0]
        vmFolder = datacenter.getVmFolder()

        # Create virtual devices
        configSpecs = []
        scsiBusKey = 0
        scsiBusNum = 0      # Limited to 3 ScsiControllers (i think)
        diskKey = 0
        diskUnitNum = 0
        diskMode = "persistent" # Changes are immediately and permanently written to the virtual disk.
        nicKey = 0
       
        if options.disk:
            scsiSpec = createScsiSpec(scsiBusKey,scsiBusNum)
            configSpecs.append(scsiSpec)

            # Limited to 15 virtual disks per ScsiController
            for disk in options.disk:
                size = int(disk)
                diskSpec = createDiskSpec(scsiBusKey,diskKey,diskUnitNum,size,diskMode,options.datastore)
                configSpecs.append(diskSpec)
                diskKey = diskKey + 1
                diskUnitNum = diskUnitNum + 1
                # Skip the unit number assigned to the scsi controller (7)
                if diskUnitNum == 7:
                    diskUnitNum = 8

        if options.nic:
            for nic in options.nic:
                netName, macAddress = nic   # Note: MacAddress validation doesn't happen through the api
                if macAddress.lower() == "generated":
                    macAddress = None
                nicSpec = createNicSpec(nicKey,netName,macAddress)
                configSpecs.append(nicSpec)
                nicKey = nicKey + 1

        vmSpec = createVmSpec(options.name,options.cpucount,options.memorysize,options.guestos,options.annotation,options.datastore,configSpecs)

        # Call the createVM_Task method on the vm folder
        task = vmFolder.createVM_Task(vmSpec, resourcePool, None)
        if task.waitForMe() == "success":
            print "%s is being created" % options.name
        else:
            print "%s was not created" % options.name

    si.getServerConnection().logout()

if __name__ == "__main__":
    main()