Module: VirtualBox

Defined in:
lib/virtualbox.rb,
lib/virtualbox/vm.rb,
lib/virtualbox/com.rb,
lib/virtualbox/cpu.rb,
lib/virtualbox/dvd.rb,
lib/virtualbox/lib.rb,
lib/virtualbox/bios.rb,
lib/virtualbox/host.rb,
lib/virtualbox/media.rb,
lib/virtualbox/global.rb,
lib/virtualbox/medium.rb,
lib/virtualbox/com/ffi.rb,
lib/virtualbox/proxies.rb,
lib/virtualbox/version.rb,
lib/virtualbox/com/util.rb,
lib/virtualbox/snapshot.rb,
lib/virtualbox/appliance.rb,
lib/virtualbox/exceptions.rb,
lib/virtualbox/ext/logger.rb,
lib/virtualbox/extra_data.rb,
lib/virtualbox/hard_drive.rb,
lib/virtualbox/nat_engine.rb,
lib/virtualbox/dhcp_server.rb,
lib/virtualbox/vrde_server.rb,
lib/virtualbox/com/ffi/util.rb,
lib/virtualbox/ext/platform.rb,
lib/virtualbox/audio_adapter.rb,
lib/virtualbox/shared_folder.rb,
lib/virtualbox/abstract_model.rb,
lib/virtualbox/forwarded_port.rb,
lib/virtualbox/usb_controller.rb,
lib/virtualbox/com/implementer.rb,
lib/virtualbox/network_adapter.rb,
lib/virtualbox/com/abstract_enum.rb,
lib/virtualbox/com/ffi/interface.rb,
lib/virtualbox/com/ffi_interface.rb,
lib/virtualbox/com/nil_interface.rb,
lib/virtualbox/hw_virtualization.rb,
lib/virtualbox/medium_attachment.rb,
lib/virtualbox/system_properties.rb,
lib/virtualbox/usb_device_filter.rb,
lib/virtualbox/com/base_interface.rb,
lib/virtualbox/nat_forwarded_port.rb,
lib/virtualbox/proxies/collection.rb,
lib/virtualbox/storage_controller.rb,
lib/virtualbox/com/implementer/ffi.rb,
lib/virtualbox/com/implementer/nil.rb,
lib/virtualbox/com/mscom_interface.rb,
lib/virtualbox/abstract_model/dirty.rb,
lib/virtualbox/com/implementer/base.rb,
lib/virtualbox/com/implementer/mscom.rb,
lib/virtualbox/com/abstract_interface.rb,
lib/virtualbox/host_network_interface.rb,
lib/virtualbox/abstract_model/relatable.rb,
lib/virtualbox/com/abstract_implementer.rb,
lib/virtualbox/com/interface/4.0.x/Host.rb,
lib/virtualbox/com/interface/4.1.x/Host.rb,
lib/virtualbox/com/interface/4.0.x/Guest.rb,
lib/virtualbox/com/interface/4.1.x/Guest.rb,
lib/virtualbox/abstract_model/validatable.rb,
lib/virtualbox/com/interface/4.0.x/Medium.rb,
lib/virtualbox/com/interface/4.1.x/Medium.rb,
lib/virtualbox/virtual_system_description.rb,
lib/virtualbox/abstract_model/attributable.rb,
lib/virtualbox/com/interface/4.0.x/Console.rb,
lib/virtualbox/com/interface/4.0.x/Machine.rb,
lib/virtualbox/com/interface/4.0.x/Session.rb,
lib/virtualbox/com/interface/4.1.x/Console.rb,
lib/virtualbox/com/interface/4.1.x/Machine.rb,
lib/virtualbox/com/interface/4.1.x/Session.rb,
lib/virtualbox/com/interface/4.0.x/AuthType.rb,
lib/virtualbox/com/interface/4.0.x/DataType.rb,
lib/virtualbox/com/interface/4.0.x/LockType.rb,
lib/virtualbox/com/interface/4.0.x/PortMode.rb,
lib/virtualbox/com/interface/4.0.x/Progress.rb,
lib/virtualbox/com/interface/4.0.x/Snapshot.rb,
lib/virtualbox/com/interface/4.1.x/AuthType.rb,
lib/virtualbox/com/interface/4.1.x/DataType.rb,
lib/virtualbox/com/interface/4.1.x/LockType.rb,
lib/virtualbox/com/interface/4.1.x/PortMode.rb,
lib/virtualbox/com/interface/4.1.x/Progress.rb,
lib/virtualbox/com/interface/4.1.x/Snapshot.rb,
lib/virtualbox/com/interface/4.0.x/Appliance.rb,
lib/virtualbox/com/interface/4.0.x/NATEngine.rb,
lib/virtualbox/com/interface/4.0.x/USBDevice.rb,
lib/virtualbox/com/interface/4.1.x/Appliance.rb,
lib/virtualbox/com/interface/4.1.x/CloneMode.rb,
lib/virtualbox/com/interface/4.1.x/NATEngine.rb,
lib/virtualbox/com/interface/4.1.x/USBDevice.rb,
lib/virtualbox/abstract_model/version_matcher.rb,
lib/virtualbox/com/interface/4.0.x/AccessMode.rb,
lib/virtualbox/com/interface/4.0.x/DHCPServer.rb,
lib/virtualbox/com/interface/4.0.x/DeviceType.rb,
lib/virtualbox/com/interface/4.0.x/MediumType.rb,
lib/virtualbox/com/interface/4.0.x/SerialPort.rb,
lib/virtualbox/com/interface/4.0.x/StorageBus.rb,
lib/virtualbox/com/interface/4.0.x/VRDEServer.rb,
lib/virtualbox/com/interface/4.0.x/VirtualBox.rb,
lib/virtualbox/com/interface/4.1.x/AccessMode.rb,
lib/virtualbox/com/interface/4.1.x/DHCPServer.rb,
lib/virtualbox/com/interface/4.1.x/DeviceType.rb,
lib/virtualbox/com/interface/4.1.x/MediumType.rb,
lib/virtualbox/com/interface/4.1.x/SerialPort.rb,
lib/virtualbox/com/interface/4.1.x/StorageBus.rb,
lib/virtualbox/com/interface/4.1.x/VRDEServer.rb,
lib/virtualbox/com/interface/4.1.x/VirtualBox.rb,
lib/virtualbox/com/interface/4.0.x/ChipsetType.rb,
lib/virtualbox/com/interface/4.0.x/CleanupMode.rb,
lib/virtualbox/com/interface/4.0.x/EventSource.rb,
lib/virtualbox/com/interface/4.0.x/GuestOSType.rb,
lib/virtualbox/com/interface/4.0.x/MediumState.rb,
lib/virtualbox/com/interface/4.0.x/NATProtocol.rb,
lib/virtualbox/com/interface/4.0.x/NSISupports.rb,
lib/virtualbox/com/interface/4.0.x/SessionType.rb,
lib/virtualbox/com/interface/4.1.x/ChipsetType.rb,
lib/virtualbox/com/interface/4.1.x/CleanupMode.rb,
lib/virtualbox/com/interface/4.1.x/EventSource.rb,
lib/virtualbox/com/interface/4.1.x/GuestOSType.rb,
lib/virtualbox/com/interface/4.1.x/MediumState.rb,
lib/virtualbox/com/interface/4.1.x/NATProtocol.rb,
lib/virtualbox/com/interface/4.1.x/NSISupports.rb,
lib/virtualbox/com/interface/4.1.x/SessionType.rb,
lib/virtualbox/com/interface/4.0.x/AudioAdapter.rb,
lib/virtualbox/com/interface/4.0.x/BIOSSettings.rb,
lib/virtualbox/com/interface/4.0.x/FirmwareType.rb,
lib/virtualbox/com/interface/4.0.x/MachineState.rb,
lib/virtualbox/com/interface/4.0.x/MediumFormat.rb,
lib/virtualbox/com/interface/4.0.x/NATAliasMode.rb,
lib/virtualbox/com/interface/4.0.x/NSIException.rb,
lib/virtualbox/com/interface/4.0.x/ParallelPort.rb,
lib/virtualbox/com/interface/4.0.x/SessionState.rb,
lib/virtualbox/com/interface/4.0.x/SharedFolder.rb,
lib/virtualbox/com/interface/4.1.x/AudioAdapter.rb,
lib/virtualbox/com/interface/4.1.x/BIOSSettings.rb,
lib/virtualbox/com/interface/4.1.x/FirmwareType.rb,
lib/virtualbox/com/interface/4.1.x/MachineState.rb,
lib/virtualbox/com/interface/4.1.x/MediumFormat.rb,
lib/virtualbox/com/interface/4.1.x/NATAliasMode.rb,
lib/virtualbox/com/interface/4.1.x/NSIException.rb,
lib/virtualbox/com/interface/4.1.x/ParallelPort.rb,
lib/virtualbox/com/interface/4.1.x/SessionState.rb,
lib/virtualbox/com/interface/4.1.x/SharedFolder.rb,
lib/virtualbox/com/interface/4.0.x/ClipboardMode.rb,
lib/virtualbox/com/interface/4.0.x/HostUSBDevice.rb,
lib/virtualbox/com/interface/4.0.x/MediumVariant.rb,
lib/virtualbox/com/interface/4.0.x/USBController.rb,
lib/virtualbox/com/interface/4.1.x/ClipboardMode.rb,
lib/virtualbox/com/interface/4.1.x/GuestDirEntry.rb,
lib/virtualbox/com/interface/4.1.x/HostUSBDevice.rb,
lib/virtualbox/com/interface/4.1.x/ImportOptions.rb,
lib/virtualbox/com/interface/4.1.x/MediumVariant.rb,
lib/virtualbox/com/interface/4.1.x/USBController.rb,
lib/virtualbox/com/interface/4.0.x/BandwidthGroup.rb,
lib/virtualbox/com/interface/4.0.x/NetworkAdapter.rb,
lib/virtualbox/com/interface/4.0.x/USBDeviceState.rb,
lib/virtualbox/com/interface/4.1.x/BandwidthGroup.rb,
lib/virtualbox/com/interface/4.1.x/NetworkAdapter.rb,
lib/virtualbox/com/interface/4.1.x/USBDeviceState.rb,
lib/virtualbox/abstract_model/interface_attributes.rb,
lib/virtualbox/com/interface/4.0.x/AudioDriverType.rb,
lib/virtualbox/com/interface/4.0.x/CpuPropertyType.rb,
lib/virtualbox/com/interface/4.0.x/KeyboardHidType.rb,
lib/virtualbox/com/interface/4.0.x/PointingHidType.rb,
lib/virtualbox/com/interface/4.0.x/USBDeviceFilter.rb,
lib/virtualbox/com/interface/4.1.x/AudioDriverType.rb,
lib/virtualbox/com/interface/4.1.x/CpuPropertyType.rb,
lib/virtualbox/com/interface/4.1.x/KeyboardHidType.rb,
lib/virtualbox/com/interface/4.1.x/PointingHidType.rb,
lib/virtualbox/com/interface/4.1.x/SettingsVersion.rb,
lib/virtualbox/com/interface/4.1.x/USBDeviceFilter.rb,
lib/virtualbox/com/interface/4.0.x/BIOSBootMenuMode.rb,
lib/virtualbox/com/interface/4.0.x/BandwidthControl.rb,
lib/virtualbox/com/interface/4.0.x/MediumAttachment.rb,
lib/virtualbox/com/interface/4.0.x/SystemProperties.rb,
lib/virtualbox/com/interface/4.1.x/BIOSBootMenuMode.rb,
lib/virtualbox/com/interface/4.1.x/BandwidthControl.rb,
lib/virtualbox/com/interface/4.1.x/MediumAttachment.rb,
lib/virtualbox/com/interface/4.1.x/SystemProperties.rb,
lib/virtualbox/com/interface/4.0.x/StorageController.rb,
lib/virtualbox/com/interface/4.1.x/AdditionsFacility.rb,
lib/virtualbox/com/interface/4.1.x/DirectoryOpenFlag.rb,
lib/virtualbox/com/interface/4.1.x/GuestDirEntryType.rb,
lib/virtualbox/com/interface/4.1.x/ProcessOutputFlag.rb,
lib/virtualbox/com/interface/4.1.x/StorageController.rb,
lib/virtualbox/com/interface/4.0.x/BandwidthGroupType.rb,
lib/virtualbox/com/interface/4.0.x/NetworkAdapterType.rb,
lib/virtualbox/com/interface/4.1.x/BandwidthGroupType.rb,
lib/virtualbox/com/interface/4.1.x/ExecuteProcessFlag.rb,
lib/virtualbox/com/interface/4.1.x/NetworkAdapterType.rb,
lib/virtualbox/com/interface/4.0.x/AudioControllerType.rb,
lib/virtualbox/com/interface/4.0.x/FaultToleranceState.rb,
lib/virtualbox/com/interface/4.0.x/HostUSBDeviceFilter.rb,
lib/virtualbox/com/interface/4.0.x/PciDeviceAttachment.rb,
lib/virtualbox/com/interface/4.0.x/VirtualBoxErrorInfo.rb,
lib/virtualbox/com/interface/4.1.x/AudioControllerType.rb,
lib/virtualbox/com/interface/4.1.x/DirectoryCreateFlag.rb,
lib/virtualbox/com/interface/4.1.x/FaultToleranceState.rb,
lib/virtualbox/com/interface/4.1.x/HostUSBDeviceFilter.rb,
lib/virtualbox/com/interface/4.1.x/PciDeviceAttachment.rb,
lib/virtualbox/com/interface/4.1.x/VirtualBoxErrorInfo.rb,
lib/virtualbox/com/interface/4.0.x/HWVirtExPropertyType.rb,
lib/virtualbox/com/interface/4.0.x/HostNetworkInterface.rb,
lib/virtualbox/com/interface/4.1.x/ExecuteProcessStatus.rb,
lib/virtualbox/com/interface/4.1.x/HWVirtExPropertyType.rb,
lib/virtualbox/com/interface/4.1.x/HostNetworkInterface.rb,
lib/virtualbox/com/interface/4.0.x/NetworkAttachmentType.rb,
lib/virtualbox/com/interface/4.0.x/StorageControllerType.rb,
lib/virtualbox/com/interface/4.0.x/USBDeviceFilterAction.rb,
lib/virtualbox/com/interface/4.1.x/AdditionsFacilityType.rb,
lib/virtualbox/com/interface/4.1.x/AdditionsRunLevelType.rb,
lib/virtualbox/com/interface/4.1.x/NetworkAttachmentType.rb,
lib/virtualbox/com/interface/4.1.x/StorageControllerType.rb,
lib/virtualbox/com/interface/4.1.x/USBDeviceFilterAction.rb,
lib/virtualbox/com/interface/4.1.x/AdditionsFacilityClass.rb,
lib/virtualbox/com/interface/4.1.x/AdditionsFacilityStatus.rb,
lib/virtualbox/com/interface/4.0.x/HostNetworkInterfaceType.rb,
lib/virtualbox/com/interface/4.0.x/VirtualSystemDescription.rb,
lib/virtualbox/com/interface/4.1.x/HostNetworkInterfaceType.rb,
lib/virtualbox/com/interface/4.1.x/VirtualSystemDescription.rb,
lib/virtualbox/com/interface/4.1.x/StorageDeviceChangedEvent.rb,
lib/virtualbox/com/interface/4.0.x/HostNetworkInterfaceStatus.rb,
lib/virtualbox/com/interface/4.1.x/HostNetworkInterfaceStatus.rb,
lib/virtualbox/com/interface/4.0.x/VirtualSystemDescriptionType.rb,
lib/virtualbox/com/interface/4.1.x/VirtualSystemDescriptionType.rb,
lib/virtualbox/com/interface/4.0.x/HostNetworkInterfaceMediumType.rb,
lib/virtualbox/com/interface/4.1.x/HostNetworkInterfaceMediumType.rb,
lib/virtualbox/com/interface/4.1.x/NetworkAdapterPromiscModePolicy.rb,
lib/virtualbox/com/interface/4.0.x/VirtualSystemDescriptionValueType.rb,
lib/virtualbox/com/interface/4.1.x/VirtualSystemDescriptionValueType.rb

Defined Under Namespace

Modules: ByteNormalizer, COM, Exceptions, Logger, Proxies, SubclassListing Classes: AbstractModel, Appliance, AudioAdapter, BIOS, CPU, DHCPServer, DVD, ExtraData, ForwardedPort, Global, HWVirtualization, HardDrive, Host, HostNetworkInterface, Lib, Media, Medium, MediumAttachment, NATEngine, NATForwardedPort, NetworkAdapter, Platform, SharedFolder, Snapshot, StorageController, SystemProperties, USBController, USBDeviceFilter, VM, VRDEServer, VirtualSystemDescription

Constant Summary collapse

VERSION = 
"0.9.0"

Class Method Summary collapse

Class Method Details

.revision(refresh = false) ⇒ Object

Returns the revision string of the VirtualBox installed, ex. “51742” This string is cached since the revision doesn’t typically change during runtime. If you must refresh the version, send the boolean ‘true` as the first parameter.



30
31
32
33
 
# File 'lib/virtualbox/version.rb', line 30

def self.revision(refresh=false)
  @_revision = Lib.lib.virtualbox.revision.to_s if @_revision.nil? || refresh
  @_revision
end

.supported? ⇒ Boolean

Returns a boolean denoting whether the current VirtualBox version is supported or not. This will return ‘false` if the version is invalid, the version is not detected, etc. That means that even if VirtualBox is not installed, this will simply return `false`.

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/virtualbox/version.rb', line 11

def self.supported?
  !version.nil?
end

.version(refresh = false) ⇒ Object

Returns the version string of the VirtualBox installed, ex. “3.1.6” This string is cached since the version typically doesn’t change during runtime. If you must refresh the version, send the boolean ‘true` as the first parameter.



19
20
21
22
23
24
 
# File 'lib/virtualbox/version.rb', line 19

def self.version(refresh=false)
  @_version = Lib.lib.virtualbox.version if @_version.nil? || refresh
  @_version
rescue Exception
  nil
end