Package pyvb :: Module vb :: Class VB

Class VB

This class is meant to be an abstraction of the VirtualBox appliacation. So there should really only be one instance of this class although there is nothing preventing it from being instantiated multiple times.

Instance Methods

[hide private]

__init__(self)
Constructor.

source code

pyvb.command.VBCommand

run(self, command)
Run the specified command on the command line.

source code

List

listVMS(self, uuid=None)
Return a list of VirtualBox virtual machines.

source code

List

listOsTypes(self)
Return a list of VitualBox-supported operating system types.

source code

List

listHostDvds(self)
Return a list of host DVDs.

source code

List

listDvds(self)
Return a list of DVDs used by virtual machines.

source code

List

listHdds(self, uuid=None)
Return a list of HDDs in use by VirtualBox.

source code

pyvb.vm.vbVM

getVM(self, uuid)
Return a specific VirtualBox virtual machine using the specified id.

source code

pyvb.hdd.vbHdd

getHDD(self, uuid)
Return a specific VirtualBox HDD using the specified id.

source code

startVM(self, vm, type='gui')
Start the specified VirtualBox virtual machine.

source code

poweroffVM(self, vm)
Poweroff the specified VirtualBox virtual machine.

source code

acpipoweroffVM(self, vm)
ACPI poweroff the specified VirtualBox virtual machine.

source code

pauseVM(self, vm)
Pause the specified VirtualBox virtual machine.

source code

resumeVM(self, vm)
Resume the specified VirtualBox virtual machine.

source code

pyvb.vm.vbVM

createVM(self, name)
Create a new virtual machine.

source code

pyvb.hdd.vbHdd

createVDI(self, filename, size)
Create a new disk-drive.

source code

pyvb.dvd.vbDvd

createDVD(self, filename)
Create a new DVD.

source code

None

attachVDI(self, vm, hdd)
Attach a disk-drive to a virtual machine.

source code

None

attachDVD(self, vm, dvd)
Attach a DVD to a virtual machine.

source code

cloneVDI(self, hdd, path)

source code

Method Details

[hide private]

init(self)
(Constructor)

source code

Constructor. Does nothing at this point.

run(self, command)

source code

Run the specified command on the command line.

Parameters:

command (pyvb.command.VBCommand) - The command to run.

Returns: pyvb.command.VBCommand

The command object that was run.

listVMS(self, uuid=None)

source code

Return a list of VirtualBox virtual machines. First we check if a specific machine is being requested. In this case, we fetch a single VM by altering the command that is run. Even if a single VM is requested, a list is still returned so the interface will remain unchanged. If a specific machine is not requested, a list of all VMs is returned.

Parameters:

uuid (String) - The id of a machine to retrieve.

Returns: List

A list of pyvb.vm.vbVM instances.

listOsTypes(self)

source code

Return a list of VitualBox-supported operating system types.

Returns: List: A list of pyvb.ostype.vbOsType instances.

listHostDvds(self)

source code

Return a list of host DVDs.

Returns: List: A list of pyvb.dvd.vbHostDvd instances.

listDvds(self)

source code

Return a list of DVDs used by virtual machines.

Returns: List: A list of pyvb.dvd.vbDvd instances.

listHdds(self, uuid=None)

source code

Return a list of HDDs in use by VirtualBox. First, we check if a specific HDD was requested. In this case, we fetch a single HDD by altering the command that is run. Even if a single HDD is requested, a list is still returned so the interface will remain unchanged. If a specific HDD is requested, a list of all HDDs is returned.