00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00130 const HRESULT VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001;
00138 const HRESULT VBOX_E_INVALID_VM_STATE = 0x80BB0002;
00146 const HRESULT VBOX_E_VM_ERROR = 0x80BB0003;
00154 const HRESULT VBOX_E_FILE_ERROR = 0x80BB0004;
00162 const HRESULT VBOX_E_IPRT_ERROR = 0x80BB0005;
00170 const HRESULT VBOX_E_PDM_ERROR = 0x80BB0006;
00178 const HRESULT VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007;
00186 const HRESULT VBOX_E_HOST_ERROR = 0x80BB0008;
00194 const HRESULT VBOX_E_NOT_SUPPORTED = 0x80BB0009;
00202 const HRESULT VBOX_E_XML_ERROR = 0x80BB000A;
00210 const HRESULT VBOX_E_INVALID_SESSION_STATE = 0x80BB000B;
00218 const HRESULT VBOX_E_OBJECT_IN_USE = 0x80BB000C;
00227 enum SettingsVersion
00228 {
00233 SettingsVersion_Null = 0,
00238 SettingsVersion_v1_0 = 1,
00243 SettingsVersion_v1_1 = 2,
00248 SettingsVersion_v1_2 = 3,
00253 SettingsVersion_v1_3pre = 4,
00258 SettingsVersion_v1_3 = 5,
00263 SettingsVersion_v1_4 = 6,
00268 SettingsVersion_v1_5 = 7,
00273 SettingsVersion_v1_6 = 8,
00278 SettingsVersion_v1_7 = 9,
00283 SettingsVersion_v1_8 = 10,
00288 SettingsVersion_v1_9 = 11,
00293 SettingsVersion_Future = 12,
00294 };
00295
00303 enum AccessMode
00304 {
00305 AccessMode_ReadOnly = 1,
00306 AccessMode_ReadWrite = 2,
00307 };
00308
00426 enum MachineState
00427 {
00432 MachineState_Null = 0,
00440 MachineState_PoweredOff = 1,
00449 MachineState_Saved = 2,
00458 MachineState_Teleported = 3,
00467 MachineState_Aborted = 4,
00474 MachineState_Running = 5,
00481 MachineState_Paused = 6,
00489 MachineState_Stuck = 7,
00499 MachineState_Teleporting = 8,
00510 MachineState_LiveSnapshotting = 9,
00518 MachineState_Starting = 10,
00526 MachineState_Stopping = 11,
00534 MachineState_Saving = 12,
00542 MachineState_Restoring = 13,
00551 MachineState_TeleportingPausedVM = 14,
00558 MachineState_TeleportingIn = 15,
00565 MachineState_RestoringSnapshot = 16,
00573 MachineState_DeletingSnapshot = 17,
00580 MachineState_SettingUp = 18,
00587 MachineState_FirstOnline = 5,
00594 MachineState_LastOnline = 13,
00601 MachineState_FirstTransient = 8,
00608 MachineState_LastTransient = 18,
00609 };
00610
00621 enum SessionState
00622 {
00627 SessionState_Null = 0,
00635 SessionState_Closed = 1,
00643 SessionState_Open = 2,
00654 SessionState_Spawning = 3,
00662 SessionState_Closing = 4,
00663 };
00664
00673 enum CpuPropertyType
00674 {
00679 CpuPropertyType_Null = 0,
00688 CpuPropertyType_PAE = 1,
00696 CpuPropertyType_Synthetic = 2,
00697 };
00698
00708 enum HWVirtExPropertyType
00709 {
00714 HWVirtExPropertyType_Null = 0,
00722 HWVirtExPropertyType_Enabled = 1,
00731 HWVirtExPropertyType_Exclusive = 2,
00738 HWVirtExPropertyType_VPID = 3,
00745 HWVirtExPropertyType_NestedPaging = 4,
00746 };
00747
00756 enum SessionType
00757 {
00762 SessionType_Null = 0,
00770 SessionType_Direct = 1,
00778 SessionType_Remote = 2,
00786 SessionType_Existing = 3,
00787 };
00788
00796 enum DeviceType
00797 {
00805 DeviceType_Null = 0,
00810 DeviceType_Floppy = 1,
00815 DeviceType_DVD = 2,
00820 DeviceType_HardDisk = 3,
00825 DeviceType_Network = 4,
00830 DeviceType_USB = 5,
00835 DeviceType_SharedFolder = 6,
00836 };
00837
00845 enum DeviceActivity
00846 {
00847 DeviceActivity_Null = 0,
00848 DeviceActivity_Idle = 1,
00849 DeviceActivity_Reading = 2,
00850 DeviceActivity_Writing = 3,
00851 };
00852
00860 enum ClipboardMode
00861 {
00862 ClipboardMode_Disabled = 0,
00863 ClipboardMode_HostToGuest = 1,
00864 ClipboardMode_GuestToHost = 2,
00865 ClipboardMode_Bidirectional = 3,
00866 };
00867
00878 enum Scope
00879 {
00880 Scope_Global = 0,
00881 Scope_Machine = 1,
00882 Scope_Session = 2,
00883 };
00884
00892 enum GuestStatisticType
00893 {
00900 GuestStatisticType_CPULoad_Idle = 0,
00907 GuestStatisticType_CPULoad_Kernel = 1,
00914 GuestStatisticType_CPULoad_User = 2,
00921 GuestStatisticType_Threads = 3,
00928 GuestStatisticType_Processes = 4,
00935 GuestStatisticType_Handles = 5,
00942 GuestStatisticType_MemoryLoad = 6,
00949 GuestStatisticType_PhysMemTotal = 7,
00956 GuestStatisticType_PhysMemAvailable = 8,
00963 GuestStatisticType_PhysMemBalloon = 9,
00970 GuestStatisticType_MemCommitTotal = 10,
00977 GuestStatisticType_MemKernelTotal = 11,
00984 GuestStatisticType_MemKernelPaged = 12,
00991 GuestStatisticType_MemKernelNonpaged = 13,
00998 GuestStatisticType_MemSystemCache = 14,
01005 GuestStatisticType_PageFileSize = 15,
01012 GuestStatisticType_SampleNumber = 16,
01013 GuestStatisticType_MaxVal = 17,
01014 };
01015
01023 enum BIOSBootMenuMode
01024 {
01025 BIOSBootMenuMode_Disabled = 0,
01026 BIOSBootMenuMode_MenuOnly = 1,
01027 BIOSBootMenuMode_MessageAndMenu = 2,
01028 };
01029
01037 enum ProcessorFeature
01038 {
01039 ProcessorFeature_HWVirtEx = 0,
01040 ProcessorFeature_PAE = 1,
01041 ProcessorFeature_LongMode = 2,
01042 ProcessorFeature_NestedPaging = 3,
01043 };
01044
01052 enum FirmwareType
01053 {
01058 FirmwareType_BIOS = 1,
01063 FirmwareType_EFI = 2,
01068 FirmwareType_EFI32 = 3,
01073 FirmwareType_EFI64 = 4,
01078 FirmwareType_EFIDUAL = 5,
01079 };
01080
01088 enum VFSType
01089 {
01090 VFSType_File = 1,
01091 VFSType_Cloud = 2,
01092 VFSType_S3 = 3,
01093 VFSType_WebDav = 4,
01094 };
01095
01103 enum VFSFileType
01104 {
01105 VFSFileType_Unknown = 1,
01106 VFSFileType_Fifo = 2,
01107 VFSFileType_DevChar = 3,
01108 VFSFileType_Directory = 4,
01109 VFSFileType_DevBlock = 5,
01110 VFSFileType_File = 6,
01111 VFSFileType_SymLink = 7,
01112 VFSFileType_Socket = 8,
01113 VFSFileType_WhiteOut = 9,
01114 };
01115
01122 enum VirtualSystemDescriptionType
01123 {
01124 VirtualSystemDescriptionType_Ignore = 1,
01125 VirtualSystemDescriptionType_OS = 2,
01126 VirtualSystemDescriptionType_Name = 3,
01127 VirtualSystemDescriptionType_Product = 4,
01128 VirtualSystemDescriptionType_Vendor = 5,
01129 VirtualSystemDescriptionType_Version = 6,
01130 VirtualSystemDescriptionType_ProductUrl = 7,
01131 VirtualSystemDescriptionType_VendorUrl = 8,
01132 VirtualSystemDescriptionType_Description = 9,
01133 VirtualSystemDescriptionType_License = 10,
01134 VirtualSystemDescriptionType_Miscellaneous = 11,
01135 VirtualSystemDescriptionType_CPU = 12,
01136 VirtualSystemDescriptionType_Memory = 13,
01137 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01138 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01139 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01140 VirtualSystemDescriptionType_HardDiskImage = 17,
01141 VirtualSystemDescriptionType_Floppy = 18,
01142 VirtualSystemDescriptionType_CDROM = 19,
01143 VirtualSystemDescriptionType_NetworkAdapter = 20,
01144 VirtualSystemDescriptionType_USBController = 21,
01145 VirtualSystemDescriptionType_SoundCard = 22,
01146 };
01147
01154 enum VirtualSystemDescriptionValueType
01155 {
01156 VirtualSystemDescriptionValueType_Reference = 1,
01157 VirtualSystemDescriptionValueType_Original = 2,
01158 VirtualSystemDescriptionValueType_Auto = 3,
01159 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01160 };
01161
01172 enum HostNetworkInterfaceMediumType
01173 {
01180 HostNetworkInterfaceMediumType_Unknown = 0,
01187 HostNetworkInterfaceMediumType_Ethernet = 1,
01194 HostNetworkInterfaceMediumType_PPP = 2,
01201 HostNetworkInterfaceMediumType_SLIP = 3,
01202 };
01203
01213 enum HostNetworkInterfaceStatus
01214 {
01221 HostNetworkInterfaceStatus_Unknown = 0,
01228 HostNetworkInterfaceStatus_Up = 1,
01235 HostNetworkInterfaceStatus_Down = 2,
01236 };
01237
01245 enum HostNetworkInterfaceType
01246 {
01247 HostNetworkInterfaceType_Bridged = 1,
01248 HostNetworkInterfaceType_HostOnly = 2,
01249 };
01250
01260 enum MediumState
01261 {
01269 MediumState_NotCreated = 0,
01278 MediumState_Created = 1,
01286 MediumState_LockedRead = 2,
01294 MediumState_LockedWrite = 3,
01304 MediumState_Inaccessible = 4,
01311 MediumState_Creating = 5,
01318 MediumState_Deleting = 6,
01319 };
01320
01330 enum MediumType
01331 {
01339 MediumType_Normal = 0,
01347 MediumType_Immutable = 1,
01355 MediumType_Writethrough = 2,
01356 };
01357
01367 enum MediumVariant
01368 {
01375 MediumVariant_Standard = 0,
01382 MediumVariant_VmdkSplit2G = 0x01,
01390 MediumVariant_VmdkStreamOptimized = 0x04,
01397 MediumVariant_VmdkESX = 0x08,
01404 MediumVariant_Fixed = 0x10000,
01411 MediumVariant_Diff = 0x20000,
01412 };
01413
01414 enum DataType
01415 {
01416 DataType_Int32 = 0,
01417 DataType_Int8 = 1,
01418 DataType_String = 2,
01419 };
01420
01421 enum DataFlags
01422 {
01423 DataFlags_None = 0x00,
01424 DataFlags_Mandatory = 0x01,
01425 DataFlags_Expert = 0x02,
01426 DataFlags_Array = 0x04,
01427 DataFlags_FlagMask = 0x07,
01428 };
01429
01437 enum MediumFormatCapabilities
01438 {
01445 MediumFormatCapabilities_Uuid = 0x01,
01452 MediumFormatCapabilities_CreateFixed = 0x02,
01460 MediumFormatCapabilities_CreateDynamic = 0x04,
01467 MediumFormatCapabilities_CreateSplit2G = 0x08,
01474 MediumFormatCapabilities_Differencing = 0x10,
01481 MediumFormatCapabilities_Asynchronous = 0x20,
01491 MediumFormatCapabilities_File = 0x40,
01500 MediumFormatCapabilities_Properties = 0x80,
01501 MediumFormatCapabilities_CapabilityMask = 0xFF,
01502 };
01503
01511 enum MouseButtonState
01512 {
01513 MouseButtonState_LeftButton = 0x01,
01514 MouseButtonState_RightButton = 0x02,
01515 MouseButtonState_MiddleButton = 0x04,
01516 MouseButtonState_WheelUp = 0x08,
01517 MouseButtonState_WheelDown = 0x10,
01518 MouseButtonState_XButton1 = 0x20,
01519 MouseButtonState_XButton2 = 0x40,
01520 MouseButtonState_MouseStateMask = 0x7F,
01521 };
01522
01533 enum FramebufferPixelFormat
01534 {
01542 FramebufferPixelFormat_Opaque = 0,
01550 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
01551 };
01552
01560 enum NetworkAttachmentType
01561 {
01566 NetworkAttachmentType_Null = 0,
01567 NetworkAttachmentType_NAT = 1,
01568 NetworkAttachmentType_Bridged = 2,
01569 NetworkAttachmentType_Internal = 3,
01570 NetworkAttachmentType_HostOnly = 4,
01571 };
01572
01580 enum NetworkAdapterType
01581 {
01586 NetworkAdapterType_Null = 0,
01591 NetworkAdapterType_Am79C970A = 1,
01596 NetworkAdapterType_Am79C973 = 2,
01601 NetworkAdapterType_I82540EM = 3,
01606 NetworkAdapterType_I82543GC = 4,
01611 NetworkAdapterType_I82545EM = 5,
01616 NetworkAdapterType_Virtio = 6,
01617 };
01618
01627 enum PortMode
01628 {
01633 PortMode_Disconnected = 0,
01638 PortMode_HostPipe = 1,
01643 PortMode_HostDevice = 2,
01648 PortMode_RawFile = 3,
01649 };
01650
01689 enum USBDeviceState
01690 {
01697 USBDeviceState_NotSupported = 0,
01705 USBDeviceState_Unavailable = 1,
01712 USBDeviceState_Busy = 2,
01720 USBDeviceState_Available = 3,
01728 USBDeviceState_Held = 4,
01736 USBDeviceState_Captured = 5,
01737 };
01738
01748 enum USBDeviceFilterAction
01749 {
01754 USBDeviceFilterAction_Null = 0,
01759 USBDeviceFilterAction_Ignore = 1,
01764 USBDeviceFilterAction_Hold = 2,
01765 };
01766
01774 enum AudioDriverType
01775 {
01780 AudioDriverType_Null = 0,
01785 AudioDriverType_WinMM = 1,
01790 AudioDriverType_OSS = 2,
01795 AudioDriverType_ALSA = 3,
01800 AudioDriverType_DirectSound = 4,
01805 AudioDriverType_CoreAudio = 5,
01810 AudioDriverType_MMPM = 6,
01815 AudioDriverType_Pulse = 7,
01820 AudioDriverType_SolAudio = 8,
01821 };
01822
01830 enum AudioControllerType
01831 {
01832 AudioControllerType_AC97 = 0,
01833 AudioControllerType_SB16 = 1,
01834 };
01835
01843 enum VRDPAuthType
01844 {
01849 VRDPAuthType_Null = 0,
01850 VRDPAuthType_External = 1,
01851 VRDPAuthType_Guest = 2,
01852 };
01853
01862 enum StorageBus
01863 {
01868 StorageBus_Null = 0,
01869 StorageBus_IDE = 1,
01870 StorageBus_SATA = 2,
01871 StorageBus_SCSI = 3,
01872 StorageBus_Floppy = 4,
01873 };
01874
01883 enum StorageControllerType
01884 {
01889 StorageControllerType_Null = 0,
01894 StorageControllerType_LsiLogic = 1,
01899 StorageControllerType_BusLogic = 2,
01904 StorageControllerType_IntelAhci = 3,
01909 StorageControllerType_PIIX3 = 4,
01914 StorageControllerType_PIIX4 = 5,
01919 StorageControllerType_ICH6 = 6,
01924 StorageControllerType_I82078 = 7,
01925 };
01926
01959 interface IVirtualBoxErrorInfo : $errorinfo
01960 {
01978 readonly attribute long resultCode;
01979
01991 readonly attribute wstringUUID interfaceID;
01992
02003 readonly attribute wstring component;
02004
02015 readonly attribute wstring text;
02016
02027 readonly attribute IVirtualBoxErrorInfo next;
02028
02029 };
02030
02043 interface ILocalOwner : $dispatched
02044 {
02053 void setLocalObject (
02054 in $unknown object
02055 );
02056
02057 };
02058
02059 interface IVirtualBoxCallback : $unknown
02060 {
02072 void onMachineStateChange (
02073 in wstringUUID machineId,
02074 in MachineState state
02075 );
02076
02084 void onMachineDataChange (
02085 in wstringUUID machineId
02086 );
02087
02118 void onExtraDataCanChange (
02119 in wstringUUID machineId,
02120 in wstring key,
02121 in wstring value,
02122 out wstring error,
02123 [retval] out boolean allowChange
02124 );
02125
02145 void onExtraDataChange (
02146 in wstringUUID machineId,
02147 in wstring key,
02148 in wstring value
02149 );
02150
02188 void onMediumRegistered (
02189 in wstringUUID mediumId,
02190 in DeviceType mediumType,
02191 in boolean registered
02192 );
02193
02207 void onMachineRegistered (
02208 in wstringUUID machineId,
02209 in boolean registered
02210 );
02211
02223 void onSessionStateChange (
02224 in wstringUUID machineId,
02225 in SessionState state
02226 );
02227
02239 void onSnapshotTaken (
02240 in wstringUUID machineId,
02241 in wstringUUID snapshotId
02242 );
02243
02265 void onSnapshotDiscarded (
02266 in wstringUUID machineId,
02267 in wstringUUID snapshotId
02268 );
02269
02281 void onSnapshotChange (
02282 in wstringUUID machineId,
02283 in wstringUUID snapshotId
02284 );
02285
02307 void onGuestPropertyChange (
02308 in wstringUUID machineId,
02309 in wstring name,
02310 in wstring value,
02311 in wstring flags
02312 );
02313
02314 };
02315
02326 interface IDHCPServer : $unknown
02327 {
02333 attribute boolean enabled;
02334
02340 readonly attribute wstring IPAddress;
02341
02347 readonly attribute wstring networkMask;
02348
02354 readonly attribute wstring networkName;
02355
02361 readonly attribute wstring lowerIP;
02362
02368 readonly attribute wstring upperIP;
02369
02398 void setConfiguration (
02399 in wstring IPAddress,
02400 in wstring networkMask,
02401 in wstring FromIPAddress,
02402 in wstring ToIPAddress
02403 );
02404
02429 void start (
02430 in wstring networkName,
02431 in wstring trunkName,
02432 in wstring trunkType
02433 );
02434
02447 void stop();
02448
02449 };
02450
02469 interface IVirtualBox : $dispatched
02470 {
02478 readonly attribute wstring version;
02479
02485 readonly attribute unsigned long revision;
02486
02496 readonly attribute wstring packageType;
02497
02513 readonly attribute wstring homeFolder;
02514
02522 readonly attribute wstring settingsFilePath;
02523
02527 readonly attribute IHost host;
02528
02532 readonly attribute ISystemProperties systemProperties;
02533
02539 readonly attribute IMachine[] machines;
02540
02550 readonly attribute IMedium[] hardDisks;
02551
02557 readonly attribute IMedium[] DVDImages;
02558
02564 readonly attribute IMedium[] floppyImages;
02565
02566 readonly attribute IProgress[] progressOperations;
02567
02568 readonly attribute IGuestOSType[] guestOSTypes;
02569
02586 readonly attribute ISharedFolder[] sharedFolders;
02587
02593 readonly attribute IPerformanceCollector performanceCollector;
02594
02600 readonly attribute IDHCPServer[] DHCPServers;
02601
02703 void createMachine (
02704 in wstring name,
02705 in wstring osTypeId,
02706 in wstring baseFolder,
02707 in wstringUUID id,
02708 [retval] out IMachine machine
02709 );
02710
02774 void createLegacyMachine (
02775 in wstring name,
02776 in wstring osTypeId,
02777 in wstring settingsFile,
02778 in wstringUUID id,
02779 [retval] out IMachine machine
02780 );
02781
02809 void openMachine (
02810 in wstring settingsFile,
02811 [retval] out IMachine machine
02812 );
02813
02846 void registerMachine (
02847 in IMachine machine
02848 );
02849
02865 void getMachine (
02866 in wstringUUID id,
02867 [retval] out IMachine machine
02868 );
02869
02885 void findMachine (
02886 in wstring name,
02887 [retval] out IMachine machine
02888 );
02889
02944 void unregisterMachine (
02945 in wstringUUID id,
02946 [retval] out IMachine machine
02947 );
02948
02958 void createAppliance (
02959 [retval] out IAppliance appliance
02960 );
02961
03027 void createHardDisk (
03028 in wstring format,
03029 in wstring location,
03030 [retval] out IMedium medium
03031 );
03032
03120 void openHardDisk (
03121 in wstring location,
03122 in AccessMode accessMode,
03123 in boolean setImageId,
03124 in wstringUUID imageId,
03125 in boolean setParentId,
03126 in wstringUUID parentId,
03127 [retval] out IMedium medium
03128 );
03129
03151 void getHardDisk (
03152 in wstringUUID id,
03153 [retval] out IMedium medium
03154 );
03155
03188 void findHardDisk (
03189 in wstring location,
03190 [retval] out IMedium medium
03191 );
03192
03242 void openDVDImage (
03243 in wstring location,
03244 in wstringUUID id,
03245 [retval] out IMedium image
03246 );
03247
03268 void getDVDImage (
03269 in wstringUUID id,
03270 [retval] out IMedium image
03271 );
03272
03311 void findDVDImage (
03312 in wstring location,
03313 [retval] out IMedium image
03314 );
03315
03365 void openFloppyImage (
03366 in wstring location,
03367 in wstringUUID id,
03368 [retval] out IMedium image
03369 );
03370
03391 void getFloppyImage (
03392 in wstringUUID id,
03393 [retval] out IMedium image
03394 );
03395
03434 void findFloppyImage (
03435 in wstring location,
03436 [retval] out IMedium image
03437 );
03438
03467 void getGuestOSType (
03468 in wstringUUID id,
03469 [retval] out IGuestOSType type
03470 );
03471
03491 void createSharedFolder (
03492 in wstring name,
03493 in wstring hostPath,
03494 in boolean writable
03495 );
03496
03511 void removeSharedFolder (
03512 in wstring name
03513 );
03514
03523 void getExtraDataKeys (
03524 [retval] out wstring[] value
03525 );
03526
03555 void getExtraData (
03556 in wstring key,
03557 [retval] out wstring value
03558 );
03559
03609 void setExtraData (
03610 in wstring key,
03611 in wstring value
03612 );
03613
03710 void openSession (
03711 in ISession session,
03712 in wstringUUID machineId
03713 );
03714
03837 void openRemoteSession (
03838 in ISession session,
03839 in wstringUUID machineId,
03840 in wstring type,
03841 in wstring environment,
03842 [retval] out IProgress progress
03843 );
03844
03914 void openExistingSession (
03915 in ISession session,
03916 in wstringUUID machineId
03917 );
03918
03936 void registerCallback (
03937 in IVirtualBoxCallback callback
03938 );
03939
03955 void unregisterCallback (
03956 in IVirtualBoxCallback callback
03957 );
03958
04046 void waitForPropertyChange (
04047 in wstring what,
04048 in unsigned long timeout,
04049 out wstring changed,
04050 out wstring values
04051 );
04052
04069 void createDHCPServer (
04070 in wstring name,
04071 [retval] out IDHCPServer server
04072 );
04073
04090 void findDHCPServerByNetworkName (
04091 in wstring name,
04092 [retval] out IDHCPServer server
04093 );
04094
04109 void removeDHCPServer (
04110 in IDHCPServer server
04111 );
04112
04137 void checkFirmwarePresent (
04138 in FirmwareType firmwareType,
04139 in wstring version,
04140 out wstring url,
04141 out wstring file,
04142 [retval] out boolean result
04143 );
04144
04145 };
04146
04157 interface IVFSExplorer : $unknown
04158 {
04162 readonly attribute wstring path;
04163
04167 readonly attribute VFSType type;
04168
04176 void update (
04177 [retval] out IProgress aProgress
04178 );
04179
04187 void cd (
04188 in wstring aDir,
04189 [retval] out IProgress aProgress
04190 );
04191
04197 void cdUp (
04198 [retval] out IProgress aProgress
04199 );
04200
04209 void entryList (
04210 out wstring[] aNames,
04211 out unsigned long[] aTypes
04212 );
04213
04222 void exists (
04223 in wstring[] aNames,
04224 [retval] out wstring[] aExists
04225 );
04226
04234 void remove (
04235 in wstring[] aNames,
04236 [retval] out IProgress aProgress
04237 );
04238
04239 };
04240
04305 interface IAppliance : $unknown
04306 {
04314 readonly attribute wstring path;
04315
04346 readonly attribute wstring[] disks;
04347
04355 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04356
04373 void read (
04374 in wstring file,
04375 [retval] out IProgress aProgress
04376 );
04377
04394 void interpret();
04395
04413 void importMachines (
04414 [retval] out IProgress aProgress
04415 );
04416
04424 void createVFSExplorer (
04425 in wstring aUri,
04426 [retval] out IVFSExplorer aExplorer
04427 );
04428
04453 void write (
04454 in wstring format,
04455 in wstring path,
04456 [retval] out IProgress aProgress
04457 );
04458
04464 void getWarnings (
04465 [retval] out wstring[] aWarnings
04466 );
04467
04468 };
04469
04480 interface IVirtualSystemDescription : $unknown
04481 {
04485 readonly attribute unsigned long count;
04486
04601 void getDescription (
04602 out VirtualSystemDescriptionType[] aTypes,
04603 out wstring[] aRefs,
04604 out wstring[] aOvfValues,
04605 out wstring[] aVBoxValues,
04606 out wstring[] aExtraConfigValues
04607 );
04608
04625 void getDescriptionByType (
04626 in VirtualSystemDescriptionType aType,
04627 out VirtualSystemDescriptionType[] aTypes,
04628 out wstring[] aRefs,
04629 out wstring[] aOvfValues,
04630 out wstring[] aVBoxValues,
04631 out wstring[] aExtraConfigValues
04632 );
04633
04645 void getValuesByType (
04646 in VirtualSystemDescriptionType aType,
04647 in VirtualSystemDescriptionValueType aWhich,
04648 [retval] out wstring[] aValues
04649 );
04650
04676 void setFinalValues (
04677 in boolean[] aEnabled,
04678 in wstring[] aVBoxValues,
04679 in wstring[] aExtraConfigValues
04680 );
04681
04696 void addDescription (
04697 in VirtualSystemDescriptionType aType,
04698 in wstring aVBoxValue,
04699 in wstring aExtraConfigValue
04700 );
04701
04702 };
04703
04704 interface IInternalMachineControl : $unknown
04705 {
04712 void setRemoveSavedState (
04713 in boolean aRemove
04714 );
04715
04727 void updateState (
04728 in MachineState state
04729 );
04730
04731 void getIPCId (
04732 [retval] out wstring id
04733 );
04734
04748 void runUSBDeviceFilters (
04749 in IUSBDevice device,
04750 out boolean matched,
04751 out unsigned long maskedInterfaces
04752 );
04753
04762 void captureUSBDevice (
04763 in wstringUUID id
04764 );
04765
04781 void detachUSBDevice (
04782 in wstringUUID id,
04783 in boolean done
04784 );
04785
04794 void autoCaptureUSBDevices();
04795
04811 void detachAllUSBDevices (
04812 in boolean done
04813 );
04814
04829 void onSessionEnd (
04830 in ISession session,
04831 [retval] out IProgress progress
04832 );
04833
04849 void beginSavingState (
04850 in IProgress progress,
04851 out wstring stateFilePath
04852 );
04853
04880 void endSavingState (
04881 in boolean success
04882 );
04883
04898 void adoptSavedState (
04899 in wstring savedStateFile
04900 );
04901
04950 void beginTakingSnapshot (
04951 in IConsole initiator,
04952 in wstring name,
04953 in wstring description,
04954 in IProgress consoleProgress,
04955 in boolean fTakingSnapshotOnline,
04956 out wstring stateFilePath
04957 );
04958
04968 void endTakingSnapshot (
04969 in boolean success
04970 );
04971
04992 void deleteSnapshot (
04993 in IConsole initiator,
04994 in wstringUUID id,
04995 out MachineState machineState,
04996 [retval] out IProgress progress
04997 );
04998
05012 void restoreSnapshot (
05013 in IConsole initiator,
05014 in ISnapshot snapshot,
05015 out MachineState machineState,
05016 [retval] out IProgress progress
05017 );
05018
05045 void pullGuestProperties (
05046 out wstring[] name,
05047 out wstring[] value,
05048 out unsigned long long[] timestamp,
05049 out wstring[] flags
05050 );
05051
05078 void pushGuestProperties (
05079 in wstring[] name,
05080 in wstring[] value,
05081 in unsigned long long[] timestamp,
05082 in wstring[] flags
05083 );
05084
05106 void pushGuestProperty (
05107 in wstring name,
05108 in wstring value,
05109 in unsigned long long timestamp,
05110 in wstring flags
05111 );
05112
05124 void lockMedia();
05125
05135 void unlockMedia();
05136
05137 };
05138
05147 interface IBIOSSettings : $unknown
05148 {
05152 attribute boolean logoFadeIn;
05153
05157 attribute boolean logoFadeOut;
05158
05162 attribute unsigned long logoDisplayTime;
05163
05167 attribute wstring logoImagePath;
05168
05172 attribute BIOSBootMenuMode bootMenuMode;
05173
05177 attribute boolean ACPIEnabled;
05178
05185 attribute boolean IOAPICEnabled;
05186
05196 attribute long long timeOffset;
05197
05204 attribute boolean PXEDebugEnabled;
05205
05206 };
05207
05248 interface IMachine : $unknown
05249 {
05253 readonly attribute IVirtualBox parent;
05254
05304 readonly attribute boolean accessible;
05305
05317 readonly attribute IVirtualBoxErrorInfo accessError;
05318
05364 attribute wstring name;
05365
05376 attribute wstring description;
05377
05381 readonly attribute wstringUUID id;
05382
05397 attribute wstring OSTypeId;
05398
05402 attribute wstring HardwareVersion;
05403
05413 attribute wstringUUID hardwareUUID;
05414
05418 attribute unsigned long CPUCount;
05419
05423 attribute unsigned long memorySize;
05424
05428 attribute unsigned long memoryBalloonSize;
05429
05433 attribute unsigned long statisticsUpdateInterval;
05434
05438 attribute unsigned long VRAMSize;
05439
05445 attribute boolean accelerate3DEnabled;
05446
05452 attribute boolean accelerate2DVideoEnabled;
05453
05464 attribute unsigned long monitorCount;
05465
05469 readonly attribute IBIOSSettings BIOSSettings;
05470
05475 attribute FirmwareType firmwareType;
05476
05510 attribute wstring snapshotFolder;
05511
05515 readonly attribute IVRDPServer VRDPServer;
05516
05520 readonly attribute IMediumAttachment[] mediumAttachments;
05521
05533 readonly attribute IUSBController USBController;
05534
05538 readonly attribute IAudioAdapter audioAdapter;
05539
05543 readonly attribute IStorageController[] storageControllers;
05544
05550 readonly attribute wstring settingsFilePath;
05551
05576 readonly attribute boolean settingsModified;
05577
05581 readonly attribute SessionState sessionState;
05582
05595 readonly attribute wstring sessionType;
05596
05608 readonly attribute unsigned long sessionPid;
05609
05613 readonly attribute MachineState state;
05614
05621 readonly attribute long long lastStateChange;
05622
05634 readonly attribute wstring stateFilePath;
05635
05645 readonly attribute wstring logFolder;
05646
05657 readonly attribute ISnapshot currentSnapshot;
05658
05665 readonly attribute unsigned long snapshotCount;
05666
05700 readonly attribute boolean currentStateModified;
05701
05713 readonly attribute ISharedFolder[] sharedFolders;
05714
05721 attribute ClipboardMode clipboardMode;
05722
05730 attribute wstring guestPropertyNotificationPatterns;
05731
05740 attribute boolean teleporterEnabled;
05741
05752 attribute unsigned long teleporterPort;
05753
05760 attribute wstring teleporterAddress;
05761
05769 attribute wstring teleporterPassword;
05770
05808 void setBootOrder (
05809 in unsigned long position,
05810 in DeviceType device
05811 );
05812
05847 void getBootOrder (
05848 in unsigned long position,
05849 [retval] out DeviceType device
05850 );
05851
05946 void attachDevice (
05947 in wstring name,
05948 in long controllerPort,
05949 in long device,
05950 in DeviceType type,
05951 in wstringUUID id
05952 );
05953
06006 void detachDevice (
06007 in wstring name,
06008 in long controllerPort,
06009 in long device
06010 );
06011
06054 void passthroughDevice (
06055 in wstring name,
06056 in long controllerPort,
06057 in long device,
06058 in boolean passthrough
06059 );
06060
06124 void mountMedium (
06125 in wstring name,
06126 in long controllerPort,
06127 in long device,
06128 in wstringUUID medium,
06129 in boolean force
06130 );
06131
06160 void getMedium (
06161 in wstring name,
06162 in long controllerPort,
06163 in long device,
06164 [retval] out IMedium medium
06165 );
06166
06181 void getMediumAttachmentsOfController (
06182 in wstring name,
06183 [retval] out IMediumAttachment[] mediumAttachments
06184 );
06185
06200 void getMediumAttachment (
06201 in wstring name,
06202 in long controllerPort,
06203 in long device,
06204 [retval] out IMediumAttachment attachment
06205 );
06206
06224 void getNetworkAdapter (
06225 in unsigned long slot,
06226 [retval] out INetworkAdapter adapter
06227 );
06228
06261 void addStorageController (
06262 in wstring name,
06263 in StorageBus connectionType,
06264 [retval] out IStorageController controller
06265 );
06266
06280 void getStorageControllerByName (
06281 in wstring name,
06282 [retval] out IStorageController storageController
06283 );
06284
06298 void getStorageControllerByInstance (
06299 in unsigned long instance,
06300 [retval] out IStorageController storageController
06301 );
06302
06316 void removeStorageController (
06317 in wstring name
06318 );
06319
06337 void getSerialPort (
06338 in unsigned long slot,
06339 [retval] out ISerialPort port
06340 );
06341
06359 void getParallelPort (
06360 in unsigned long slot,
06361 [retval] out IParallelPort port
06362 );
06363
06372 void getExtraDataKeys (
06373 [retval] out wstring[] value
06374 );
06375
06404 void getExtraData (
06405 in wstring key,
06406 [retval] out wstring value
06407 );
06408
06458 void setExtraData (
06459 in wstring key,
06460 in wstring value
06461 );
06462
06484 void getCpuProperty (
06485 in CpuPropertyType property,
06486 [retval] out boolean value
06487 );
06488
06510 void setCpuProperty (
06511 in CpuPropertyType property,
06512 in boolean value
06513 );
06514
06554 void getCpuIdLeaf (
06555 in unsigned long id,
06556 out unsigned long valEax,
06557 out unsigned long valEbx,
06558 out unsigned long valEcx,
06559 out unsigned long valEdx
06560 );
06561
06605 void setCpuIdLeaf (
06606 in unsigned long id,
06607 in unsigned long valEax,
06608 in unsigned long valEbx,
06609 in unsigned long valEcx,
06610 in unsigned long valEdx
06611 );
06612
06630 void removeCpuIdLeaf (
06631 in unsigned long id
06632 );
06633
06639 void removeAllCpuIdLeafs();
06640
06662 void getHWVirtExProperty (
06663 in HWVirtExPropertyType property,
06664 [retval] out boolean value
06665 );
06666
06688 void setHWVirtExProperty (
06689 in HWVirtExPropertyType property,
06690 in boolean value
06691 );
06692
06738 void saveSettings();
06739
06763 void discardSettings();
06764
06806 void deleteSettings();
06807
06817 void export (
06818 in IAppliance aAppliance,
06819 [retval] out IVirtualSystemDescription aDescription
06820 );
06821
06842 void getSnapshot (
06843 in wstringUUID id,
06844 [retval] out ISnapshot snapshot
06845 );
06846
06864 void findSnapshot (
06865 in wstring name,
06866 [retval] out ISnapshot snapshot
06867 );
06868
06881 void setCurrentSnapshot (
06882 in wstringUUID id
06883 );
06884
06915 void createSharedFolder (
06916 in wstring name,
06917 in wstring hostPath,
06918 in boolean writable
06919 );
06920
06946 void removeSharedFolder (
06947 in wstring name
06948 );
06949
06973 void canShowConsoleWindow (
06974 [retval] out boolean canShow
06975 );
06976
07011 void showConsoleWindow (
07012 [retval] out unsigned long long winId
07013 );
07014
07047 void getGuestProperty (
07048 in wstring name,
07049 out wstring value,
07050 out unsigned long long timestamp,
07051 out wstring flags
07052 );
07053
07076 void getGuestPropertyValue (
07077 in wstring property,
07078 [retval] out wstring value
07079 );
07080
07103 void getGuestPropertyTimestamp (
07104 in wstring property,
07105 [retval] out unsigned long long value
07106 );
07107
07158 void setGuestProperty (
07159 in wstring property,
07160 in wstring value,
07161 in wstring flags
07162 );
07163
07204 void setGuestPropertyValue (
07205 in wstring property,
07206 in wstring value
07207 );
07208
07239 void enumerateGuestProperties (
07240 in wstring patterns,
07241 out wstring[] name,
07242 out wstring[] value,
07243 out unsigned long long[] timestamp,
07244 out wstring[] flags
07245 );
07246
07264 void querySavedThumbnailSize (
07265 out unsigned long size,
07266 out unsigned long width,
07267 out unsigned long height
07268 );
07269
07292 void readSavedThumbnailToArray (
07293 in boolean BGR,
07294 out unsigned long width,
07295 out unsigned long height,
07296 [retval] out octet[] data
07297 );
07298
07316 void querySavedScreenshotPNGSize (
07317 out unsigned long size,
07318 out unsigned long width,
07319 out unsigned long height
07320 );
07321
07339 void readSavedScreenshotPNGToArray (
07340 out unsigned long width,
07341 out unsigned long height,
07342 [retval] out octet[] data
07343 );
07344
07345 };
07346
07365 interface IConsoleCallback : $unknown
07366 {
07433 void onMousePointerShapeChange (
07434 in boolean visible,
07435 in boolean alpha,
07436 in unsigned long xHot,
07437 in unsigned long yHot,
07438 in unsigned long width,
07439 in unsigned long height,
07440 in octetPtr shape
07441 );
07442
07449 void onMouseCapabilityChange (
07450 in boolean supportsAbsolute,
07451 in boolean needsHostCursor
07452 );
07453
07460 void onKeyboardLedsChange (
07461 in boolean numLock,
07462 in boolean capsLock,
07463 in boolean scrollLock
07464 );
07465
07472 void onStateChange (
07473 in MachineState state
07474 );
07475
07483 void onAdditionsStateChange();
07484
07495 void onNetworkAdapterChange (
07496 in INetworkAdapter networkAdapter
07497 );
07498
07509 void onSerialPortChange (
07510 in ISerialPort serialPort
07511 );
07512
07523 void onParallelPortChange (
07524 in IParallelPort parallelPort
07525 );
07526
07535 void onStorageControllerChange();
07536
07546 void onMediumChange (
07547 in IMediumAttachment mediumAttachment
07548 );
07549
07558 void onVRDPServerChange();
07559
07567 void onRemoteDisplayInfoChange();
07568
07577 void onUSBControllerChange();
07578
07611 void onUSBDeviceStateChange (
07612 in IUSBDevice device,
07613 in boolean attached,
07614 in IVirtualBoxErrorInfo error
07615 );
07616
07632 void onSharedFolderChange (
07633 in Scope scope
07634 );
07635
07700 void onRuntimeError (
07701 in boolean fatal,
07702 in wstring id,
07703 in wstring message
07704 );
07705
07733 void onCanShowWindow (
07734 [retval] out boolean canShow
07735 );
07736
07783 void onShowWindow (
07784 [retval] out unsigned long long winId
07785 );
07786
07787 };
07788
07797 interface IRemoteDisplayInfo : $unknown
07798 {
07804 readonly attribute boolean active;
07805
07814 readonly attribute long port;
07815
07821 readonly attribute unsigned long numberOfClients;
07822
07828 readonly attribute long long beginTime;
07829
07836 readonly attribute long long endTime;
07837
07843 readonly attribute unsigned long long bytesSent;
07844
07850 readonly attribute unsigned long long bytesSentTotal;
07851
07857 readonly attribute unsigned long long bytesReceived;
07858
07864 readonly attribute unsigned long long bytesReceivedTotal;
07865
07871 readonly attribute wstring user;
07872
07878 readonly attribute wstring domain;
07879
07885 readonly attribute wstring clientName;
07886
07892 readonly attribute wstring clientIP;
07893
07899 readonly attribute unsigned long clientVersion;
07900
07908 readonly attribute unsigned long encryptionStyle;
07909
07910 };
07911
07934 interface IConsole : $unknown
07935 {
07947 readonly attribute IMachine machine;
07948
07962 readonly attribute MachineState state;
07963
07967 readonly attribute IGuest guest;
07968
07979 readonly attribute IKeyboard keyboard;
07980
07991 readonly attribute IMouse mouse;
07992
08002 readonly attribute IDisplay display;
08003
08007 readonly attribute IMachineDebugger debugger;
08008
08019 readonly attribute IUSBDevice[] USBDevices;
08020
08028 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08029
08045 readonly attribute ISharedFolder[] sharedFolders;
08046
08052 readonly attribute IRemoteDisplayInfo remoteDisplayInfo;
08053
08107 void powerUp (
08108 [retval] out IProgress progress
08109 );
08110
08144 void powerUpPaused (
08145 [retval] out IProgress progress
08146 );
08147
08167 void powerDown (
08168 [retval] out IProgress progress
08169 );
08170
08190 void reset();
08191
08211 void pause();
08212
08232 void resume();
08233
08253 void powerButton();
08254
08274 void sleepButton();
08275
08287 void getPowerButtonHandled (
08288 [retval] out boolean handled
08289 );
08290
08304 void getGuestEnteredACPIMode (
08305 [retval] out boolean entered
08306 );
08307
08360 void saveState (
08361 [retval] out IProgress progress
08362 );
08363
08396 void adoptSavedState (
08397 in wstring savedStateFile
08398 );
08399
08422 void forgetSavedState (
08423 in boolean remove
08424 );
08425
08438 void getDeviceActivity (
08439 in DeviceType type,
08440 [retval] out DeviceActivity activity
08441 );
08442
08479 void attachUSBDevice (
08480 in wstringUUID id
08481 );
08482
08516 void detachUSBDevice (
08517 in wstringUUID id,
08518 [retval] out IUSBDevice device
08519 );
08520
08543 void findUSBDeviceByAddress (
08544 in wstring name,
08545 [retval] out IUSBDevice device
08546 );
08547
08567 void findUSBDeviceById (
08568 in wstringUUID id,
08569 [retval] out IUSBDevice device
08570 );
08571
08602 void createSharedFolder (
08603 in wstring name,
08604 in wstring hostPath,
08605 in boolean writable
08606 );
08607
08632 void removeSharedFolder (
08633 in wstring name
08634 );
08635
08673 void takeSnapshot (
08674 in wstring name,
08675 in wstring description,
08676 [retval] out IProgress progress
08677 );
08678
08745 void deleteSnapshot (
08746 in wstringUUID id,
08747 [retval] out IProgress progress
08748 );
08749
08790 void restoreSnapshot (
08791 in ISnapshot snapshot,
08792 [retval] out IProgress progress
08793 );
08794
08833 void teleport (
08834 in wstring hostname,
08835 in unsigned long tcpport,
08836 in wstring password,
08837 in unsigned long maxDowntime,
08838 [retval] out IProgress progress
08839 );
08840
08848 void registerCallback (
08849 in IConsoleCallback callback
08850 );
08851
08865 void unregisterCallback (
08866 in IConsoleCallback callback
08867 );
08868
08869 };
08870
08881 interface IHostNetworkInterface : $unknown
08882 {
08886 readonly attribute wstring name;
08887
08891 readonly attribute wstringUUID id;
08892
08896 readonly attribute wstring networkName;
08897
08901 readonly attribute boolean dhcpEnabled;
08902
08906 readonly attribute wstring IPAddress;
08907
08911 readonly attribute wstring networkMask;
08912
08916 readonly attribute boolean IPV6Supported;
08917
08921 readonly attribute wstring IPV6Address;
08922
08926 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
08927
08931 readonly attribute wstring hardwareAddress;
08932
08936 readonly attribute HostNetworkInterfaceMediumType mediumType;
08937
08941 readonly attribute HostNetworkInterfaceStatus status;
08942
08946 readonly attribute HostNetworkInterfaceType interfaceType;
08947
08959 void enableStaticIpConfig (
08960 in wstring IPAddress,
08961 in wstring networkMask
08962 );
08963
08975 void enableStaticIpConfigV6 (
08976 in wstring IPV6Address,
08977 in unsigned long IPV6NetworkMaskPrefixLength
08978 );
08979
08983 void enableDynamicIpConfig();
08984
08988 void dhcpRediscover();
08989
08990 };
08991
09008 interface IHost : $unknown
09009 {
09013 readonly attribute IMedium[] DVDDrives;
09014
09018 readonly attribute IMedium[] floppyDrives;
09019
09033 readonly attribute IHostUSBDevice[] USBDevices;
09034
09057 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
09058
09062 readonly attribute IHostNetworkInterface[] networkInterfaces;
09063
09067 readonly attribute unsigned long processorCount;
09068
09072 readonly attribute unsigned long processorOnlineCount;
09073
09077 readonly attribute unsigned long memorySize;
09078
09082 readonly attribute unsigned long memoryAvailable;
09083
09087 readonly attribute wstring operatingSystem;
09088
09092 readonly attribute wstring OSVersion;
09093
09097 readonly attribute long long UTCTime;
09098
09102 readonly attribute boolean Acceleration3DAvailable;
09103
09118 void getProcessorSpeed (
09119 in unsigned long cpuId,
09120 [retval] out unsigned long speed
09121 );
09122
09134 void getProcessorFeature (
09135 in ProcessorFeature feature,
09136 [retval] out boolean supported
09137 );
09138
09157 void getProcessorDescription (
09158 in unsigned long cpuId,
09159 [retval] out wstring description
09160 );
09161
09202 void getProcessorCpuIdLeaf (
09203 in unsigned long cpuId,
09204 in unsigned long leaf,
09205 in unsigned long subLeaf,
09206 out unsigned long valEax,
09207 out unsigned long valEbx,
09208 out unsigned long valEcx,
09209 out unsigned long valEdx
09210 );
09211
09232 void createHostOnlyNetworkInterface (
09233 out IHostNetworkInterface hostInterface,
09234 [retval] out IProgress progress
09235 );
09236
09257 void removeHostOnlyNetworkInterface (
09258 in wstringUUID id,
09259 [retval] out IProgress progress
09260 );
09261
09282 void createUSBDeviceFilter (
09283 in wstring name,
09284 [retval] out IHostUSBDeviceFilter filter
09285 );
09286
09329 void insertUSBDeviceFilter (
09330 in unsigned long position,
09331 in IHostUSBDeviceFilter filter
09332 );
09333
09361 void removeUSBDeviceFilter (
09362 in unsigned long position
09363 );
09364
09382 void findHostDVDDrive (
09383 in wstring name,
09384 [retval] out IMedium drive
09385 );
09386
09404 void findHostFloppyDrive (
09405 in wstring name,
09406 [retval] out IMedium drive
09407 );
09408
09424 void findHostNetworkInterfaceByName (
09425 in wstring name,
09426 [retval] out IHostNetworkInterface networkInterface
09427 );
09428
09444 void findHostNetworkInterfaceById (
09445 in wstringUUID id,
09446 [retval] out IHostNetworkInterface networkInterface
09447 );
09448
09458 void findHostNetworkInterfacesOfType (
09459 in HostNetworkInterfaceType type,
09460 [retval] out IHostNetworkInterface[] networkInterfaces
09461 );
09462
09482 void findUSBDeviceById (
09483 in wstringUUID id,
09484 [retval] out IHostUSBDevice device
09485 );
09486
09509 void findUSBDeviceByAddress (
09510 in wstring name,
09511 [retval] out IHostUSBDevice device
09512 );
09513
09514 };
09515
09528 interface ISystemProperties : $unknown
09529 {
09533 readonly attribute unsigned long minGuestRAM;
09534
09538 readonly attribute unsigned long maxGuestRAM;
09539
09543 readonly attribute unsigned long minGuestVRAM;
09544
09548 readonly attribute unsigned long maxGuestVRAM;
09549
09553 readonly attribute unsigned long minGuestCPUCount;
09554
09558 readonly attribute unsigned long maxGuestCPUCount;
09559
09563 readonly attribute unsigned long long maxVDISize;
09564
09571 readonly attribute unsigned long networkAdapterCount;
09572
09579 readonly attribute unsigned long serialPortCount;
09580
09587 readonly attribute unsigned long parallelPortCount;
09588
09598 readonly attribute unsigned long maxBootPosition;
09599
09632 attribute wstring defaultMachineFolder;
09633
09672 attribute wstring defaultHardDiskFolder;
09673
09699 readonly attribute IMediumFormat[] mediumFormats;
09700
09734 attribute wstring defaultHardDiskFormat;
09735
09759 attribute wstring remoteDisplayAuthLibrary;
09760
09789 attribute wstring webServiceAuthLibrary;
09790
09796 attribute unsigned long LogHistoryCount;
09797
09802 readonly attribute AudioDriverType defaultAudioDriver;
09803
09813 void getMaxDevicesPerPortForStorageBus (
09814 in StorageBus bus,
09815 [retval] out unsigned long maxDevicesPerPort
09816 );
09817
09825 void getMinPortCountForStorageBus (
09826 in StorageBus bus,
09827 [retval] out unsigned long minPortCount
09828 );
09829
09837 void getMaxPortCountForStorageBus (
09838 in StorageBus bus,
09839 [retval] out unsigned long maxPortCount
09840 );
09841
09851 void getMaxInstancesOfStorageBus (
09852 in StorageBus bus,
09853 [retval] out unsigned long maxInstances
09854 );
09855
09865 void getDeviceTypesForStorageBus (
09866 in StorageBus bus,
09867 [retval] out DeviceType[] deviceTypes
09868 );
09869
09870 };
09871
09877 interface IGuestOSType : $unknown
09878 {
09882 readonly attribute wstring familyId;
09883
09887 readonly attribute wstring familyDescription;
09888
09892 readonly attribute wstring id;
09893
09897 readonly attribute wstring description;
09898
09902 readonly attribute boolean is64Bit;
09903
09907 readonly attribute boolean recommendedIOAPIC;
09908
09912 readonly attribute boolean recommendedVirtEx;
09913
09917 readonly attribute unsigned long recommendedRAM;
09918
09922 readonly attribute unsigned long recommendedVRAM;
09923
09927 readonly attribute unsigned long recommendedHDD;
09928
09932 readonly attribute NetworkAdapterType adapterType;
09933
09934 };
09935
09949 interface IGuest : $unknown
09950 {
09965 readonly attribute wstring OSTypeId;
09966
09974 readonly attribute boolean additionsActive;
09975
09985 readonly attribute wstring additionsVersion;
09986
09993 readonly attribute boolean supportsSeamless;
09994
10003 readonly attribute boolean supportsGraphics;
10004
10008 attribute unsigned long memoryBalloonSize;
10009
10013 attribute unsigned long statisticsUpdateInterval;
10014
10044 void setCredentials (
10045 in wstring userName,
10046 in wstring password,
10047 in wstring domain,
10048 in boolean allowInteractiveLogon
10049 );
10050
10062 void getStatistic (
10063 in unsigned long cpuId,
10064 in GuestStatisticType statistic,
10065 [retval] out unsigned long statVal
10066 );
10067
10068 };
10069
10110 interface IProgress : $unknown
10111 {
10115 readonly attribute wstringUUID id;
10116
10120 readonly attribute wstring description;
10121
10125 readonly attribute $unknown initiator;
10126
10130 readonly attribute boolean cancelable;
10131
10139 readonly attribute unsigned long percent;
10140
10154 readonly attribute long timeRemaining;
10155
10159 readonly attribute boolean completed;
10160
10164 readonly attribute boolean canceled;
10165
10172 readonly attribute long resultCode;
10173
10183 readonly attribute IVirtualBoxErrorInfo errorInfo;
10184
10191 readonly attribute unsigned long operationCount;
10192
10196 readonly attribute unsigned long operation;
10197
10203 readonly attribute wstring operationDescription;
10204
10208 readonly attribute unsigned long operationPercent;
10209
10217 attribute unsigned long timeout;
10218
10222 void setCurrentOperationProgress (
10223 in unsigned long percent
10224 );
10225
10229 void setNextOperation (
10230 in wstring nextOperationDescription,
10231 in unsigned long nextOperationsWeight
10232 );
10233
10252 void waitForCompletion (
10253 in long timeout
10254 );
10255
10279 void waitForOperationCompletion (
10280 in unsigned long operation,
10281 in long timeout
10282 );
10283
10300 void cancel();
10301
10302 };
10303
10395 interface ISnapshot : $unknown
10396 {
10400 readonly attribute wstringUUID id;
10401
10405 attribute wstring name;
10406
10410 attribute wstring description;
10411
10417 readonly attribute long long timeStamp;
10418
10430 readonly attribute boolean online;
10431
10443 readonly attribute IMachine machine;
10444
10451 readonly attribute ISnapshot parent;
10452
10458 readonly attribute ISnapshot[] children;
10459
10460 };
10461
10477 interface IMediumAttachment : $unknown
10478 {
10483 readonly attribute IMedium medium;
10484
10490 readonly attribute wstring controller;
10491
10495 readonly attribute long port;
10496
10500 readonly attribute long device;
10501
10505 readonly attribute DeviceType type;
10506
10510 readonly attribute boolean passthrough;
10511
10512 };
10513
10859 interface IMedium : $unknown
10860 {
10874 readonly attribute wstringUUID id;
10875
10894 attribute wstring description;
10895
10911 readonly attribute MediumState state;
10912
10934 attribute wstring location;
10935
10955 readonly attribute wstring name;
10956
10961 readonly attribute DeviceType deviceType;
10962
10966 readonly attribute boolean hostDrive;
10967
10980 readonly attribute unsigned long long size;
10981
10996 readonly attribute wstring format;
10997
11022 attribute MediumType type;
11023
11033 readonly attribute IMedium parent;
11034
11042 readonly attribute IMedium[] children;
11043
11054 readonly attribute IMedium base;
11055
11088 readonly attribute boolean readOnly;
11089
11110 readonly attribute unsigned long long logicalSize;
11111
11139 attribute boolean autoReset;
11140
11155 readonly attribute wstring lastAccessError;
11156
11173 readonly attribute wstringUUID[] machineIds;
11174
11209 void refreshState (
11210 [retval] out MediumState state
11211 );
11212
11239 void getSnapshotIds (
11240 in wstringUUID machineId,
11241 [retval] out wstringUUID[] snapshotIds
11242 );
11243
11303 void lockRead (
11304 [retval] out MediumState state
11305 );
11306
11329 void unlockRead (
11330 [retval] out MediumState state
11331 );
11332
11387 void lockWrite (
11388 [retval] out MediumState state
11389 );
11390
11413 void unlockWrite (
11414 [retval] out MediumState state
11415 );
11416
11465 void close();
11466
11496 void getProperty (
11497 in wstring name,
11498 [retval] out wstring value
11499 );
11500
11532 void setProperty (
11533 in wstring name,
11534 in wstring value
11535 );
11536
11570 void getProperties (
11571 in wstring names,
11572 out wstring[] returnNames,
11573 [retval] out wstring[] returnValues
11574 );
11575
11607 void setProperties (
11608 in wstring[] names,
11609 in wstring[] values
11610 );
11611
11643 void createBaseStorage (
11644 in unsigned long long logicalSize,
11645 in MediumVariant variant,
11646 [retval] out IProgress progress
11647 );
11648
11700 void deleteStorage (
11701 [retval] out IProgress progress
11702 );
11703
11741 void createDiffStorage (
11742 in IMedium target,
11743 in MediumVariant variant,
11744 [retval] out IProgress progress
11745 );
11746
11822 void mergeTo (
11823 in wstringUUID targetId,
11824 [retval] out IProgress progress
11825 );
11826
11875 void cloneTo (
11876 in IMedium target,
11877 in MediumVariant variant,
11878 in IMedium parent,
11879 [retval] out IProgress progress
11880 );
11881
11910 void compact (
11911 [retval] out IProgress progress
11912 );
11913
11946 void resize (
11947 in unsigned long long logicalSize,
11948 [retval] out IProgress progress
11949 );
11950
11984 void reset (
11985 [retval] out IProgress progress
11986 );
11987
11988 };
11989
12012 interface IMediumFormat : $unknown
12013 {
12032 readonly attribute wstring id;
12033
12041 readonly attribute wstring name;
12042
12058 readonly attribute wstring[] fileExtensions;
12059
12068 readonly attribute unsigned long capabilities;
12069
12099 void describeProperties (
12100 out wstring[] names,
12101 out wstring[] description,
12102 out DataType[] types,
12103 out unsigned long[] flags,
12104 out wstring[] defaults
12105 );
12106
12107 };
12108
12121 interface IKeyboard : $unknown
12122 {
12135 void putScancode (
12136 in long scancode
12137 );
12138
12151 void putScancodes (
12152 in long[] scancodes,
12153 [retval] out unsigned long codesStored
12154 );
12155
12170 void putCAD();
12171
12172 };
12173
12185 interface IMouse : $unknown
12186 {
12203 readonly attribute boolean absoluteSupported;
12204
12270 void putMouseEvent (
12271 in long dx,
12272 in long dy,
12273 in long dz,
12274 in long dw,
12275 in long buttonState
12276 );
12277
12350 void putMouseEventAbsolute (
12351 in long x,
12352 in long y,
12353 in long dz,
12354 in long dw,
12355 in long buttonState
12356 );
12357
12358 };
12359
12360 interface IFramebuffer : $unknown
12361 {
12370 readonly attribute octetPtr address;
12371
12375 readonly attribute unsigned long width;
12376
12380 readonly attribute unsigned long height;
12381
12388 readonly attribute unsigned long bitsPerPixel;
12389
12396 readonly attribute unsigned long bytesPerLine;
12397
12408 readonly attribute unsigned long pixelFormat;
12409
12416 readonly attribute boolean usesGuestVRAM;
12417
12427 readonly attribute unsigned long heightReduction;
12428
12443 readonly attribute IFramebufferOverlay overlay;
12444
12451 readonly attribute unsigned long long winId;
12452
12460 void lock();
12461
12469 void unlock();
12470
12478 void notifyUpdate (
12479 in unsigned long x,
12480 in unsigned long y,
12481 in unsigned long width,
12482 in unsigned long height
12483 );
12484
12597 void requestResize (
12598 in unsigned long screenId,
12599 in unsigned long pixelFormat,
12600 in octetPtr VRAM,
12601 in unsigned long bitsPerPixel,
12602 in unsigned long bytesPerLine,
12603 in unsigned long width,
12604 in unsigned long height,
12605 [retval] out boolean finished
12606 );
12607
12619 void videoModeSupported (
12620 in unsigned long width,
12621 in unsigned long height,
12622 in unsigned long bpp,
12623 [retval] out boolean supported
12624 );
12625
12662 void getVisibleRegion (
12663 in octetPtr rectangles,
12664 in unsigned long count,
12665 [retval] out unsigned long countCopied
12666 );
12667
12702 void setVisibleRegion (
12703 in octetPtr rectangles,
12704 in unsigned long count
12705 );
12706
12727 void processVHWACommand (
12728 in octetPtr command
12729 );
12730
12731 };
12732
12747 interface IFramebufferOverlay : IFramebuffer
12748 {
12752 readonly attribute unsigned long x;
12753
12757 readonly attribute unsigned long y;
12758
12764 attribute boolean visible;
12765
12772 attribute unsigned long alpha;
12773
12779 void move (
12780 in unsigned long x,
12781 in unsigned long y
12782 );
12783
12784 };
12785
12801 interface IDisplay : $unknown
12802 {
12806 readonly attribute unsigned long width;
12807
12811 readonly attribute unsigned long height;
12812
12819 readonly attribute unsigned long bitsPerPixel;
12820
12826 void setFramebuffer (
12827 in unsigned long screenId,
12828 in IFramebuffer framebuffer
12829 );
12830
12836 void getFramebuffer (
12837 in unsigned long screenId,
12838 out IFramebuffer framebuffer,
12839 out long xOrigin,
12840 out long yOrigin
12841 );
12842
12871 void setVideoModeHint (
12872 in unsigned long width,
12873 in unsigned long height,
12874 in unsigned long bitsPerPixel,
12875 in unsigned long display
12876 );
12877
12888 void setSeamlessMode (
12889 in boolean enabled
12890 );
12891
12925 void takeScreenShot (
12926 in octetPtr address,
12927 in unsigned long width,
12928 in unsigned long height
12929 );
12930
12970 void takeScreenShotSlow (
12971 in unsigned long width,
12972 in unsigned long height,
12973 [retval] out octet[] screenData
12974 );
12975
13003 void drawToScreen (
13004 in octetPtr address,
13005 in unsigned long x,
13006 in unsigned long y,
13007 in unsigned long width,
13008 in unsigned long height
13009 );
13010
13025 void invalidateAndUpdate();
13026
13040 void resizeCompleted (
13041 in unsigned long screenId
13042 );
13043
13057 void updateCompleted();
13058
13071 void completeVHWACommand (
13072 in octetPtr command
13073 );
13074
13075 };
13076
13092 interface INetworkAdapter : $unknown
13093 {
13101 attribute NetworkAdapterType adapterType;
13102
13110 readonly attribute unsigned long slot;
13111
13120 attribute boolean enabled;
13121
13128 attribute wstring MACAddress;
13129
13130 readonly attribute NetworkAttachmentType attachmentType;
13131
13137 attribute wstring hostInterface;
13138
13144 attribute wstring internalNetwork;
13145
13151 attribute wstring NATNetwork;
13152
13159 attribute boolean cableConnected;
13160
13166 attribute unsigned long lineSpeed;
13167
13174 attribute boolean traceEnabled;
13175
13182 attribute wstring traceFile;
13183
13189 void attachToNAT();
13190
13196 void attachToBridgedInterface();
13197
13203 void attachToInternalNetwork();
13204
13210 void attachToHostOnlyInterface();
13211
13217 void detach();
13218
13219 };
13220
13249 interface ISerialPort : $unknown
13250 {
13258 readonly attribute unsigned long slot;
13259
13266 attribute boolean enabled;
13267
13271 attribute unsigned long IOBase;
13272
13276 attribute unsigned long IRQ;
13277
13288 attribute PortMode hostMode;
13289
13297 attribute boolean server;
13298
13308 attribute wstring path;
13309
13310 };
13311
13331 interface IParallelPort : $unknown
13332 {
13340 readonly attribute unsigned long slot;
13341
13348 attribute boolean enabled;
13349
13353 attribute unsigned long IOBase;
13354
13358 attribute unsigned long IRQ;
13359
13367 attribute wstring path;
13368
13369 };
13370
13371 interface IMachineDebugger : $unknown
13372 {
13376 attribute boolean singlestep;
13377
13381 attribute boolean recompileUser;
13382
13386 attribute boolean recompileSupervisor;
13387
13391 attribute boolean PATMEnabled;
13392
13396 attribute boolean CSAMEnabled;
13397
13401 attribute boolean logEnabled;
13402
13409 readonly attribute boolean HWVirtExEnabled;
13410
13417 readonly attribute boolean HWVirtExNestedPagingEnabled;
13418
13425 readonly attribute boolean HWVirtExVPIDEnabled;
13426
13433 readonly attribute boolean PAEEnabled;
13434
13441 attribute unsigned long virtualTimeRate;
13442
13449 readonly attribute unsigned long long VM;
13450
13458 void resetStats (
13459 in wstring pattern
13460 );
13461
13469 void dumpStats (
13470 in wstring pattern
13471 );
13472
13484 void getStats (
13485 in wstring pattern,
13486 in boolean withDescriptions,
13487 out wstring stats
13488 );
13489
13495 void injectNMI();
13496
13497 };
13498
13499 interface IUSBController : $unknown
13500 {
13509 attribute boolean enabled;
13510
13519 attribute boolean enabledEhci;
13520
13528 readonly attribute unsigned short USBStandard;
13529
13555 readonly attribute IUSBDeviceFilter[] deviceFilters;
13556
13584 void createDeviceFilter (
13585 in wstring name,
13586 [retval] out IUSBDeviceFilter filter
13587 );
13588
13633 void insertDeviceFilter (
13634 in unsigned long position,
13635 in IUSBDeviceFilter filter
13636 );
13637
13670 void removeDeviceFilter (
13671 in unsigned long position,
13672 [retval] out IUSBDeviceFilter filter
13673 );
13674
13675 };
13676
13689 interface IUSBDevice : $unknown
13690 {
13697 readonly attribute wstringUUID id;
13698
13702 readonly attribute unsigned short vendorId;
13703
13707 readonly attribute unsigned short productId;
13708
13716 readonly attribute unsigned short revision;
13717
13721 readonly attribute wstring manufacturer;
13722
13726 readonly attribute wstring product;
13727
13731 readonly attribute wstring serialNumber;
13732
13736 readonly attribute wstring address;
13737
13744 readonly attribute unsigned short port;
13745
13751 readonly attribute unsigned short version;
13752
13760 readonly attribute unsigned short portVersion;
13761
13768 readonly attribute boolean remote;
13769
13770 };
13771
13845 interface IUSBDeviceFilter : $unknown
13846 {
13854 attribute wstring name;
13855
13859 attribute boolean active;
13860
13868 attribute wstring vendorId;
13869
13877 attribute wstring productId;
13878
13892 attribute wstring revision;
13893
13898 attribute wstring manufacturer;
13899
13904 attribute wstring product;
13905
13910 attribute wstring serialNumber;
13911
13916 attribute wstring port;
13917
13927 attribute wstring remote;
13928
13938 attribute unsigned long maskedInterfaces;
13939
13940 };
13941
13957 interface IHostUSBDevice : IUSBDevice
13958 {
13964 readonly attribute USBDeviceState state;
13965
13966 };
13967
13990 interface IHostUSBDeviceFilter : IUSBDeviceFilter
13991 {
13998 attribute USBDeviceFilterAction action;
13999
14000 };
14001
14010 interface IAudioAdapter : $unknown
14011 {
14020 attribute boolean enabled;
14021
14027 attribute AudioControllerType audioController;
14028
14035 attribute AudioDriverType audioDriver;
14036
14037 };
14038
14039 interface IVRDPServer : $unknown
14040 {
14044 attribute boolean enabled;
14045
14055 attribute wstring ports;
14056
14060 attribute wstring netAddress;
14061
14065 attribute VRDPAuthType authType;
14066
14070 attribute unsigned long authTimeout;
14071
14078 attribute boolean allowMultiConnection;
14079
14087 attribute boolean reuseSingleConnection;
14088
14089 };
14090
14148 interface ISharedFolder : $unknown
14149 {
14153 readonly attribute wstring name;
14154
14158 readonly attribute wstring hostPath;
14159
14169 readonly attribute boolean accessible;
14170
14177 readonly attribute boolean writable;
14178
14191 readonly attribute wstring lastAccessError;
14192
14193 };
14194
14195 interface IInternalSessionControl : $unknown
14196 {
14201 void getPID (
14202 [retval] out unsigned long pid
14203 );
14204
14226 void getRemoteConsole (
14227 [retval] out IConsole console
14228 );
14229
14253 void assignMachine (
14254 in IMachine machine
14255 );
14256
14271 void assignRemoteMachine (
14272 in IMachine machine,
14273 in IConsole console
14274 );
14275
14299 void updateMachineState (
14300 in MachineState aMachineState
14301 );
14302
14318 void uninitialize();
14319
14342 void onNetworkAdapterChange (
14343 in INetworkAdapter networkAdapter,
14344 in boolean changeAdapter
14345 );
14346
14369 void onSerialPortChange (
14370 in ISerialPort serialPort
14371 );
14372
14395 void onParallelPortChange (
14396 in IParallelPort parallelPort
14397 );
14398
14421 void onStorageControllerChange();
14422
14445 void onMediumChange (
14446 in IMediumAttachment mediumAttachment,
14447 in boolean force
14448 );
14449
14472 void onVRDPServerChange();
14473
14496 void onUSBControllerChange();
14497
14526 void onSharedFolderChange (
14527 in boolean global
14528 );
14529
14555 void onUSBDeviceAttach (
14556 in IUSBDevice device,
14557 in IVirtualBoxErrorInfo error,
14558 in unsigned long maskedInterfaces
14559 );
14560
14586 void onUSBDeviceDetach (
14587 in wstringUUID id,
14588 in IVirtualBoxErrorInfo error
14589 );
14590
14608 void onShowWindow (
14609 in boolean check,
14610 out boolean canShow,
14611 out unsigned long long winId
14612 );
14613
14637 void accessGuestProperty (
14638 in wstring name,
14639 in wstring value,
14640 in wstring flags,
14641 in boolean isSetter,
14642 out wstring retValue,
14643 out unsigned long long retTimestamp,
14644 out wstring retFlags
14645 );
14646
14694 void enumerateGuestProperties (
14695 in wstring patterns,
14696 out wstring[] key,
14697 out wstring[] value,
14698 out unsigned long long[] timestamp,
14699 out wstring[] flags
14700 );
14701
14702 };
14703
14780 interface ISession : $dispatched
14781 {
14785 readonly attribute SessionState state;
14786
14794 readonly attribute SessionType type;
14795
14799 readonly attribute IMachine machine;
14800
14804 readonly attribute IConsole console;
14805
14846 void close();
14847
14848 };
14849
14872 interface IStorageController : $unknown
14873 {
14882 readonly attribute wstring name;
14883
14889 readonly attribute unsigned long maxDevicesPerPortCount;
14890
14896 readonly attribute unsigned long minPortCount;
14897
14903 readonly attribute unsigned long maxPortCount;
14904
14910 attribute unsigned long instance;
14911
14920 attribute unsigned long portCount;
14921
14927 readonly attribute StorageBus bus;
14928
14941 attribute StorageControllerType controllerType;
14942
14965 void GetIDEEmulationPort (
14966 in long devicePosition,
14967 [retval] out long portNumber
14968 );
14969
14993 void SetIDEEmulationPort (
14994 in long devicePosition,
14995 in long portNumber
14996 );
14997
14998 };
14999
15023 interface IManagedObjectRef : $unknown
15024 {
15031 void getInterfaceName (
15032 [retval] out wstring return
15033 );
15034
15042 void release();
15043
15044 };
15045
15054 interface IWebsessionManager : $unknown
15055 {
15064 void logon (
15065 in wstring username,
15066 in wstring password,
15067 [retval] out IVirtualBox return
15068 );
15069
15079 void getSessionObject (
15080 in IVirtualBox refIVirtualBox,
15081 [retval] out ISession return
15082 );
15083
15091 void logoff (
15092 in IVirtualBox refIVirtualBox
15093 );
15094
15095 };
15096
15105 interface IPerformanceMetric : $unknown
15106 {
15112 readonly attribute wstring metricName;
15113
15119 readonly attribute $unknown object;
15120
15126 readonly attribute wstring description;
15127
15133 readonly attribute unsigned long period;
15134
15144 readonly attribute unsigned long count;
15145
15151 readonly attribute wstring unit;
15152
15158 readonly attribute long minimumValue;
15159
15165 readonly attribute long maximumValue;
15166
15167 };
15168
15269 interface IPerformanceCollector : $unknown
15270 {
15281 readonly attribute wstring[] metricNames;
15282
15306 void getMetrics (
15307 in wstring[] metricNames,
15308 in $unknown[] objects,
15309 [retval] out IPerformanceMetric[] metrics
15310 );
15311
15350 void setupMetrics (
15351 in wstring[] metricNames,
15352 in $unknown[] objects,
15353 in unsigned long period,
15354 in unsigned long count,
15355 [retval] out IPerformanceMetric[] affectedMetrics
15356 );
15357
15386 void enableMetrics (
15387 in wstring[] metricNames,
15388 in $unknown[] objects,
15389 [retval] out IPerformanceMetric[] affectedMetrics
15390 );
15391
15420 void disableMetrics (
15421 in wstring[] metricNames,
15422 in $unknown[] objects,
15423 [retval] out IPerformanceMetric[] affectedMetrics
15424 );
15425
15514 void queryMetricsData (
15515 in wstring[] metricNames,
15516 in $unknown[] objects,
15517 out wstring[] returnMetricNames,
15518 out $unknown[] returnObjects,
15519 out wstring[] returnUnits,
15520 out unsigned long[] returnScales,
15521 out unsigned long[] returnSequenceNumbers,
15522 out unsigned long[] returnDataIndices,
15523 out unsigned long[] returnDataLengths,
15524 [retval] out long[] returnData
15525 );
15526
15527 };
15528
15529