idx
int64
0
63k
question
stringlengths
61
4.03k
target
stringlengths
6
1.23k
8,900
def set_cpu_property ( self , property_p , value ) : if not isinstance ( property_p , CPUPropertyType ) : raise TypeError ( "property_p can only be an instance of type CPUPropertyType" ) if not isinstance ( value , bool ) : raise TypeError ( "value can only be an instance of type bool" ) self . _call ( "setCPUProperty" , in_p = [ property_p , value ] )
Sets the virtual CPU boolean value of the specified property .
8,901
def get_cpuid_leaf_by_ordinal ( self , ordinal ) : if not isinstance ( ordinal , baseinteger ) : raise TypeError ( "ordinal can only be an instance of type baseinteger" ) ( idx , idx_sub , val_eax , val_ebx , val_ecx , val_edx ) = self . _call ( "getCPUIDLeafByOrdinal" , in_p = [ ordinal ] ) return ( idx , idx_sub , val_eax , val_ebx , val_ecx , val_edx )
Used to enumerate CPUID information override values .
8,902
def remove_cpuid_leaf ( self , idx , idx_sub ) : if not isinstance ( idx , baseinteger ) : raise TypeError ( "idx can only be an instance of type baseinteger" ) if not isinstance ( idx_sub , baseinteger ) : raise TypeError ( "idx_sub can only be an instance of type baseinteger" ) self . _call ( "removeCPUIDLeaf" , in_p = [ idx , idx_sub ] )
Removes the virtual CPU cpuid leaf for the specified index
8,903
def get_hw_virt_ex_property ( self , property_p ) : if not isinstance ( property_p , HWVirtExPropertyType ) : raise TypeError ( "property_p can only be an instance of type HWVirtExPropertyType" ) value = self . _call ( "getHWVirtExProperty" , in_p = [ property_p ] ) return value
Returns the value of the specified hardware virtualization boolean property .
8,904
def set_hw_virt_ex_property ( self , property_p , value ) : if not isinstance ( property_p , HWVirtExPropertyType ) : raise TypeError ( "property_p can only be an instance of type HWVirtExPropertyType" ) if not isinstance ( value , bool ) : raise TypeError ( "value can only be an instance of type bool" ) self . _call ( "setHWVirtExProperty" , in_p = [ property_p , value ] )
Sets a new value for the specified hardware virtualization boolean property .
8,905
def get_guest_property ( self , name ) : if not isinstance ( name , basestring ) : raise TypeError ( "name can only be an instance of type basestring" ) ( value , timestamp , flags ) = self . _call ( "getGuestProperty" , in_p = [ name ] ) return ( value , timestamp , flags )
Reads an entry from the machine s guest property store .
8,906
def get_guest_property_value ( self , property_p ) : if not isinstance ( property_p , basestring ) : raise TypeError ( "property_p can only be an instance of type basestring" ) value = self . _call ( "getGuestPropertyValue" , in_p = [ property_p ] ) return value
Reads a value from the machine s guest property store .
8,907
def set_guest_property ( self , property_p , value , flags ) : if not isinstance ( property_p , basestring ) : raise TypeError ( "property_p can only be an instance of type basestring" ) if not isinstance ( value , basestring ) : raise TypeError ( "value can only be an instance of type basestring" ) if not isinstance ( flags , basestring ) : raise TypeError ( "flags can only be an instance of type basestring" ) self . _call ( "setGuestProperty" , in_p = [ property_p , value , flags ] )
Sets changes or deletes an entry in the machine s guest property store .
8,908
def set_guest_property_value ( self , property_p , value ) : if not isinstance ( property_p , basestring ) : raise TypeError ( "property_p can only be an instance of type basestring" ) if not isinstance ( value , basestring ) : raise TypeError ( "value can only be an instance of type basestring" ) self . _call ( "setGuestPropertyValue" , in_p = [ property_p , value ] )
Sets or changes a value in the machine s guest property store . The flags field will be left unchanged or created empty for a new property .
8,909
def delete_guest_property ( self , name ) : if not isinstance ( name , basestring ) : raise TypeError ( "name can only be an instance of type basestring" ) self . _call ( "deleteGuestProperty" , in_p = [ name ] )
Deletes an entry from the machine s guest property store .
8,910
def enumerate_guest_properties ( self , patterns ) : if not isinstance ( patterns , basestring ) : raise TypeError ( "patterns can only be an instance of type basestring" ) ( names , values , timestamps , flags ) = self . _call ( "enumerateGuestProperties" , in_p = [ patterns ] ) return ( names , values , timestamps , flags )
Return a list of the guest properties matching a set of patterns along with their values timestamps and flags .
8,911
def query_saved_guest_screen_info ( self , screen_id ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) ( origin_x , origin_y , width , height , enabled ) = self . _call ( "querySavedGuestScreenInfo" , in_p = [ screen_id ] ) return ( origin_x , origin_y , width , height , enabled )
Returns the guest dimensions from the saved state .
8,912
def query_saved_screenshot_info ( self , screen_id ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) ( bitmap_formats , width , height ) = self . _call ( "querySavedScreenshotInfo" , in_p = [ screen_id ] ) bitmap_formats = [ BitmapFormat ( a ) for a in bitmap_formats ] return ( bitmap_formats , width , height )
Returns available formats and size of the screenshot from saved state .
8,913
def read_saved_screenshot_to_array ( self , screen_id , bitmap_format ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( bitmap_format , BitmapFormat ) : raise TypeError ( "bitmap_format can only be an instance of type BitmapFormat" ) ( data , width , height ) = self . _call ( "readSavedScreenshotToArray" , in_p = [ screen_id , bitmap_format ] ) return ( data , width , height )
Screenshot in requested format is retrieved to an array of bytes .
8,914
def hot_plug_cpu ( self , cpu ) : if not isinstance ( cpu , baseinteger ) : raise TypeError ( "cpu can only be an instance of type baseinteger" ) self . _call ( "hotPlugCPU" , in_p = [ cpu ] )
Plugs a CPU into the machine .
8,915
def hot_unplug_cpu ( self , cpu ) : if not isinstance ( cpu , baseinteger ) : raise TypeError ( "cpu can only be an instance of type baseinteger" ) self . _call ( "hotUnplugCPU" , in_p = [ cpu ] )
Removes a CPU from the machine .
8,916
def get_cpu_status ( self , cpu ) : if not isinstance ( cpu , baseinteger ) : raise TypeError ( "cpu can only be an instance of type baseinteger" ) attached = self . _call ( "getCPUStatus" , in_p = [ cpu ] ) return attached
Returns the current status of the given CPU .
8,917
def query_log_filename ( self , idx ) : if not isinstance ( idx , baseinteger ) : raise TypeError ( "idx can only be an instance of type baseinteger" ) filename = self . _call ( "queryLogFilename" , in_p = [ idx ] ) return filename
Queries for the VM log file name of an given index . Returns an empty string if a log file with that index doesn t exists .
8,918
def read_log ( self , idx , offset , size ) : if not isinstance ( idx , baseinteger ) : raise TypeError ( "idx can only be an instance of type baseinteger" ) if not isinstance ( offset , baseinteger ) : raise TypeError ( "offset can only be an instance of type baseinteger" ) if not isinstance ( size , baseinteger ) : raise TypeError ( "size can only be an instance of type baseinteger" ) data = self . _call ( "readLog" , in_p = [ idx , offset , size ] ) return data
Reads the VM log file . The chunk size is limited so even if you ask for a big piece there might be less data returned .
8,919
def apply_defaults ( self , flags ) : if not isinstance ( flags , basestring ) : raise TypeError ( "flags can only be an instance of type basestring" ) self . _call ( "applyDefaults" , in_p = [ flags ] )
Applies the defaults for the configured guest OS type . This is primarily for getting sane settings straight after creating a new VM but it can also be applied later . This is primarily a shortcut centralizing the tedious job of getting the recommended settings and translating them into settings updates . The settings are made at the end of the call but not saved .
8,920
def webcam_attach ( self , path , settings ) : if not isinstance ( path , basestring ) : raise TypeError ( "path can only be an instance of type basestring" ) if not isinstance ( settings , basestring ) : raise TypeError ( "settings can only be an instance of type basestring" ) self . _call ( "webcamAttach" , in_p = [ path , settings ] )
Attaches the emulated USB webcam to the VM which will use a host video capture device .
8,921
def webcam_detach ( self , path ) : if not isinstance ( path , basestring ) : raise TypeError ( "path can only be an instance of type basestring" ) self . _call ( "webcamDetach" , in_p = [ path ] )
Detaches the emulated USB webcam from the VM
8,922
def get_device_activity ( self , type_p ) : if not isinstance ( type_p , list ) : raise TypeError ( "type_p can only be an instance of type list" ) for a in type_p [ : 10 ] : if not isinstance ( a , DeviceType ) : raise TypeError ( "array can only contain objects of type DeviceType" ) activity = self . _call ( "getDeviceActivity" , in_p = [ type_p ] ) activity = [ DeviceActivity ( a ) for a in activity ] return activity
Gets the current activity type of given devices or device groups .
8,923
def enable_static_ip_config ( self , ip_address , network_mask ) : if not isinstance ( ip_address , basestring ) : raise TypeError ( "ip_address can only be an instance of type basestring" ) if not isinstance ( network_mask , basestring ) : raise TypeError ( "network_mask can only be an instance of type basestring" ) self . _call ( "enableStaticIPConfig" , in_p = [ ip_address , network_mask ] )
sets and enables the static IP V4 configuration for the given interface .
8,924
def enable_static_ip_config_v6 ( self , ipv6_address , ipv6_network_mask_prefix_length ) : if not isinstance ( ipv6_address , basestring ) : raise TypeError ( "ipv6_address can only be an instance of type basestring" ) if not isinstance ( ipv6_network_mask_prefix_length , baseinteger ) : raise TypeError ( "ipv6_network_mask_prefix_length can only be an instance of type baseinteger" ) self . _call ( "enableStaticIPConfigV6" , in_p = [ ipv6_address , ipv6_network_mask_prefix_length ] )
sets and enables the static IP V6 configuration for the given interface .
8,925
def get_processor_feature ( self , feature ) : if not isinstance ( feature , ProcessorFeature ) : raise TypeError ( "feature can only be an instance of type ProcessorFeature" ) supported = self . _call ( "getProcessorFeature" , in_p = [ feature ] ) return supported
Query whether a CPU feature is supported or not .
8,926
def get_processor_description ( self , cpu_id ) : if not isinstance ( cpu_id , baseinteger ) : raise TypeError ( "cpu_id can only be an instance of type baseinteger" ) description = self . _call ( "getProcessorDescription" , in_p = [ cpu_id ] ) return description
Query the model string of a specified host CPU .
8,927
def get_processor_cpuid_leaf ( self , cpu_id , leaf , sub_leaf ) : if not isinstance ( cpu_id , baseinteger ) : raise TypeError ( "cpu_id can only be an instance of type baseinteger" ) if not isinstance ( leaf , baseinteger ) : raise TypeError ( "leaf can only be an instance of type baseinteger" ) if not isinstance ( sub_leaf , baseinteger ) : raise TypeError ( "sub_leaf can only be an instance of type baseinteger" ) ( val_eax , val_ebx , val_ecx , val_edx ) = self . _call ( "getProcessorCPUIDLeaf" , in_p = [ cpu_id , leaf , sub_leaf ] ) return ( val_eax , val_ebx , val_ecx , val_edx )
Returns the CPU cpuid information for the specified leaf .
8,928
def create_host_only_network_interface ( self ) : ( progress , host_interface ) = self . _call ( "createHostOnlyNetworkInterface" ) progress = IProgress ( progress ) host_interface = IHostNetworkInterface ( host_interface ) return ( progress , host_interface )
Creates a new adapter for Host Only Networking .
8,929
def remove_host_only_network_interface ( self , id_p ) : if not isinstance ( id_p , basestring ) : raise TypeError ( "id_p can only be an instance of type basestring" ) progress = self . _call ( "removeHostOnlyNetworkInterface" , in_p = [ id_p ] ) progress = IProgress ( progress ) return progress
Removes the given Host Only Networking interface .
8,930
def find_host_network_interface_by_id ( self , id_p ) : if not isinstance ( id_p , basestring ) : raise TypeError ( "id_p can only be an instance of type basestring" ) network_interface = self . _call ( "findHostNetworkInterfaceById" , in_p = [ id_p ] ) network_interface = IHostNetworkInterface ( network_interface ) return network_interface
Searches through all host network interfaces for an interface with the given GUID . The method returns an error if the given GUID does not correspond to any host network interface .
8,931
def find_host_network_interfaces_of_type ( self , type_p ) : if not isinstance ( type_p , HostNetworkInterfaceType ) : raise TypeError ( "type_p can only be an instance of type HostNetworkInterfaceType" ) network_interfaces = self . _call ( "findHostNetworkInterfacesOfType" , in_p = [ type_p ] ) network_interfaces = [ IHostNetworkInterface ( a ) for a in network_interfaces ] return network_interfaces
Searches through all host network interfaces and returns a list of interfaces of the specified type
8,932
def add_usb_device_source ( self , backend , id_p , address , property_names , property_values ) : if not isinstance ( backend , basestring ) : raise TypeError ( "backend can only be an instance of type basestring" ) if not isinstance ( id_p , basestring ) : raise TypeError ( "id_p can only be an instance of type basestring" ) if not isinstance ( address , basestring ) : raise TypeError ( "address can only be an instance of type basestring" ) if not isinstance ( property_names , list ) : raise TypeError ( "property_names can only be an instance of type list" ) for a in property_names [ : 10 ] : if not isinstance ( a , basestring ) : raise TypeError ( "array can only contain objects of type basestring" ) if not isinstance ( property_values , list ) : raise TypeError ( "property_values can only be an instance of type list" ) for a in property_values [ : 10 ] : if not isinstance ( a , basestring ) : raise TypeError ( "array can only contain objects of type basestring" ) self . _call ( "addUSBDeviceSource" , in_p = [ backend , id_p , address , property_names , property_values ] )
Adds a new USB device source .
8,933
def remove_usb_device_source ( self , id_p ) : if not isinstance ( id_p , basestring ) : raise TypeError ( "id_p can only be an instance of type basestring" ) self . _call ( "removeUSBDeviceSource" , in_p = [ id_p ] )
Removes a previously added USB device source .
8,934
def get_max_devices_per_port_for_storage_bus ( self , bus ) : if not isinstance ( bus , StorageBus ) : raise TypeError ( "bus can only be an instance of type StorageBus" ) max_devices_per_port = self . _call ( "getMaxDevicesPerPortForStorageBus" , in_p = [ bus ] ) return max_devices_per_port
Returns the maximum number of devices which can be attached to a port for the given storage bus .
8,935
def get_min_port_count_for_storage_bus ( self , bus ) : if not isinstance ( bus , StorageBus ) : raise TypeError ( "bus can only be an instance of type StorageBus" ) min_port_count = self . _call ( "getMinPortCountForStorageBus" , in_p = [ bus ] ) return min_port_count
Returns the minimum number of ports the given storage bus supports .
8,936
def get_max_port_count_for_storage_bus ( self , bus ) : if not isinstance ( bus , StorageBus ) : raise TypeError ( "bus can only be an instance of type StorageBus" ) max_port_count = self . _call ( "getMaxPortCountForStorageBus" , in_p = [ bus ] ) return max_port_count
Returns the maximum number of ports the given storage bus supports .
8,937
def get_max_instances_of_storage_bus ( self , chipset , bus ) : if not isinstance ( chipset , ChipsetType ) : raise TypeError ( "chipset can only be an instance of type ChipsetType" ) if not isinstance ( bus , StorageBus ) : raise TypeError ( "bus can only be an instance of type StorageBus" ) max_instances = self . _call ( "getMaxInstancesOfStorageBus" , in_p = [ chipset , bus ] ) return max_instances
Returns the maximum number of storage bus instances which can be configured for each VM . This corresponds to the number of storage controllers one can have . Value may depend on chipset type used .
8,938
def get_storage_controller_hotplug_capable ( self , controller_type ) : if not isinstance ( controller_type , StorageControllerType ) : raise TypeError ( "controller_type can only be an instance of type StorageControllerType" ) hotplug_capable = self . _call ( "getStorageControllerHotplugCapable" , in_p = [ controller_type ] ) return hotplug_capable
Returns whether the given storage controller supports hot - plugging devices .
8,939
def get_max_instances_of_usb_controller_type ( self , chipset , type_p ) : if not isinstance ( chipset , ChipsetType ) : raise TypeError ( "chipset can only be an instance of type ChipsetType" ) if not isinstance ( type_p , USBControllerType ) : raise TypeError ( "type_p can only be an instance of type USBControllerType" ) max_instances = self . _call ( "getMaxInstancesOfUSBControllerType" , in_p = [ chipset , type_p ] ) return max_instances
Returns the maximum number of USB controller instances which can be configured for each VM . This corresponds to the number of USB controllers one can have . Value may depend on chipset type used .
8,940
def drag_is_pending ( self , screen_id ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) ( default_action , formats , allowed_actions ) = self . _call ( "dragIsPending" , in_p = [ screen_id ] ) default_action = DnDAction ( default_action ) allowed_actions = [ DnDAction ( a ) for a in allowed_actions ] return ( default_action , formats , allowed_actions )
Ask the source if there is any drag and drop operation pending . If no drag and drop operation is pending currently DnDAction_Ignore is returned .
8,941
def drop ( self , format_p , action ) : if not isinstance ( format_p , basestring ) : raise TypeError ( "format_p can only be an instance of type basestring" ) if not isinstance ( action , DnDAction ) : raise TypeError ( "action can only be an instance of type DnDAction" ) progress = self . _call ( "drop" , in_p = [ format_p , action ] ) progress = IProgress ( progress ) return progress
Informs the source that a drop event occurred for a pending drag and drop operation .
8,942
def enter ( self , screen_id , y , x , default_action , allowed_actions , formats ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( y , baseinteger ) : raise TypeError ( "y can only be an instance of type baseinteger" ) if not isinstance ( x , baseinteger ) : raise TypeError ( "x can only be an instance of type baseinteger" ) if not isinstance ( default_action , DnDAction ) : raise TypeError ( "default_action can only be an instance of type DnDAction" ) if not isinstance ( allowed_actions , list ) : raise TypeError ( "allowed_actions can only be an instance of type list" ) for a in allowed_actions [ : 10 ] : if not isinstance ( a , DnDAction ) : raise TypeError ( "array can only contain objects of type DnDAction" ) if not isinstance ( formats , list ) : raise TypeError ( "formats can only be an instance of type list" ) for a in formats [ : 10 ] : if not isinstance ( a , basestring ) : raise TypeError ( "array can only contain objects of type basestring" ) result_action = self . _call ( "enter" , in_p = [ screen_id , y , x , default_action , allowed_actions , formats ] ) result_action = DnDAction ( result_action ) return result_action
Informs the target about a drag and drop enter event .
8,943
def leave ( self , screen_id ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) self . _call ( "leave" , in_p = [ screen_id ] )
Informs the target about a drag and drop leave event .
8,944
def send_data ( self , screen_id , format_p , data ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( format_p , basestring ) : raise TypeError ( "format_p can only be an instance of type basestring" ) if not isinstance ( data , list ) : raise TypeError ( "data can only be an instance of type list" ) for a in data [ : 10 ] : if not isinstance ( a , basestring ) : raise TypeError ( "array can only contain objects of type basestring" ) progress = self . _call ( "sendData" , in_p = [ screen_id , format_p , data ] ) progress = IProgress ( progress ) return progress
Initiates sending data to the target .
8,945
def directory_copy ( self , source , destination , flags ) : if not isinstance ( source , basestring ) : raise TypeError ( "source can only be an instance of type basestring" ) if not isinstance ( destination , basestring ) : raise TypeError ( "destination can only be an instance of type basestring" ) if not isinstance ( flags , list ) : raise TypeError ( "flags can only be an instance of type list" ) for a in flags [ : 10 ] : if not isinstance ( a , DirectoryCopyFlag ) : raise TypeError ( "array can only contain objects of type DirectoryCopyFlag" ) progress = self . _call ( "directoryCopy" , in_p = [ source , destination , flags ] ) progress = IProgress ( progress ) return progress
Recursively copies a directory from one guest location to another .
8,946
def directory_create ( self , path , mode , flags ) : if not isinstance ( path , basestring ) : raise TypeError ( "path can only be an instance of type basestring" ) if not isinstance ( mode , baseinteger ) : raise TypeError ( "mode can only be an instance of type baseinteger" ) if not isinstance ( flags , list ) : raise TypeError ( "flags can only be an instance of type list" ) for a in flags [ : 10 ] : if not isinstance ( a , DirectoryCreateFlag ) : raise TypeError ( "array can only contain objects of type DirectoryCreateFlag" ) self . _call ( "directoryCreate" , in_p = [ path , mode , flags ] )
Creates a directory in the guest .
8,947
def directory_create_temp ( self , template_name , mode , path , secure ) : if not isinstance ( template_name , basestring ) : raise TypeError ( "template_name can only be an instance of type basestring" ) if not isinstance ( mode , baseinteger ) : raise TypeError ( "mode can only be an instance of type baseinteger" ) if not isinstance ( path , basestring ) : raise TypeError ( "path can only be an instance of type basestring" ) if not isinstance ( secure , bool ) : raise TypeError ( "secure can only be an instance of type bool" ) directory = self . _call ( "directoryCreateTemp" , in_p = [ template_name , mode , path , secure ] ) return directory
Creates a temporary directory in the guest .
8,948
def directory_remove ( self , path ) : if not isinstance ( path , basestring ) : raise TypeError ( "path can only be an instance of type basestring" ) self . _call ( "directoryRemove" , in_p = [ path ] )
Removes a guest directory if empty . Symbolic links in the final component will not be followed instead an not - a - directory error is reported .
8,949
def file_create_temp ( self , template_name , mode , path , secure ) : if not isinstance ( template_name , basestring ) : raise TypeError ( "template_name can only be an instance of type basestring" ) if not isinstance ( mode , baseinteger ) : raise TypeError ( "mode can only be an instance of type baseinteger" ) if not isinstance ( path , basestring ) : raise TypeError ( "path can only be an instance of type basestring" ) if not isinstance ( secure , bool ) : raise TypeError ( "secure can only be an instance of type bool" ) file_p = self . _call ( "fileCreateTemp" , in_p = [ template_name , mode , path , secure ] ) file_p = IGuestFile ( file_p ) return file_p
Creates a temporary file in the guest .
8,950
def file_query_size ( self , path , follow_symlinks ) : if not isinstance ( path , basestring ) : raise TypeError ( "path can only be an instance of type basestring" ) if not isinstance ( follow_symlinks , bool ) : raise TypeError ( "follow_symlinks can only be an instance of type bool" ) size = self . _call ( "fileQuerySize" , in_p = [ path , follow_symlinks ] ) return size
Queries the size of a regular file in the guest .
8,951
def symlink_create ( self , symlink , target , type_p ) : if not isinstance ( symlink , basestring ) : raise TypeError ( "symlink can only be an instance of type basestring" ) if not isinstance ( target , basestring ) : raise TypeError ( "target can only be an instance of type basestring" ) if not isinstance ( type_p , SymlinkType ) : raise TypeError ( "type_p can only be an instance of type SymlinkType" ) self . _call ( "symlinkCreate" , in_p = [ symlink , target , type_p ] )
Creates a symbolic link in the guest .
8,952
def symlink_exists ( self , symlink ) : if not isinstance ( symlink , basestring ) : raise TypeError ( "symlink can only be an instance of type basestring" ) exists = self . _call ( "symlinkExists" , in_p = [ symlink ] ) return exists
Checks whether a symbolic link exists in the guest .
8,953
def symlink_read ( self , symlink , flags ) : if not isinstance ( symlink , basestring ) : raise TypeError ( "symlink can only be an instance of type basestring" ) if not isinstance ( flags , list ) : raise TypeError ( "flags can only be an instance of type list" ) for a in flags [ : 10 ] : if not isinstance ( a , SymlinkReadFlag ) : raise TypeError ( "array can only contain objects of type SymlinkReadFlag" ) target = self . _call ( "symlinkRead" , in_p = [ symlink , flags ] ) return target
Reads the target value of a symbolic link in the guest .
8,954
def wait_for ( self , wait_for , timeout_ms ) : if not isinstance ( wait_for , baseinteger ) : raise TypeError ( "wait_for can only be an instance of type baseinteger" ) if not isinstance ( timeout_ms , baseinteger ) : raise TypeError ( "timeout_ms can only be an instance of type baseinteger" ) reason = self . _call ( "waitFor" , in_p = [ wait_for , timeout_ms ] ) reason = ProcessWaitResult ( reason ) return reason
Waits for one or more events to happen .
8,955
def write ( self , handle , flags , data , timeout_ms ) : if not isinstance ( handle , baseinteger ) : raise TypeError ( "handle can only be an instance of type baseinteger" ) if not isinstance ( flags , baseinteger ) : raise TypeError ( "flags can only be an instance of type baseinteger" ) if not isinstance ( data , list ) : raise TypeError ( "data can only be an instance of type list" ) for a in data [ : 10 ] : if not isinstance ( a , basestring ) : raise TypeError ( "array can only contain objects of type basestring" ) if not isinstance ( timeout_ms , baseinteger ) : raise TypeError ( "timeout_ms can only be an instance of type baseinteger" ) written = self . _call ( "write" , in_p = [ handle , flags , data , timeout_ms ] ) return written
Writes data to a running process .
8,956
def read ( self , to_read , timeout_ms ) : if not isinstance ( to_read , baseinteger ) : raise TypeError ( "to_read can only be an instance of type baseinteger" ) if not isinstance ( timeout_ms , baseinteger ) : raise TypeError ( "timeout_ms can only be an instance of type baseinteger" ) data = self . _call ( "read" , in_p = [ to_read , timeout_ms ] ) return data
Reads data from this file .
8,957
def read_at ( self , offset , to_read , timeout_ms ) : if not isinstance ( offset , baseinteger ) : raise TypeError ( "offset can only be an instance of type baseinteger" ) if not isinstance ( to_read , baseinteger ) : raise TypeError ( "to_read can only be an instance of type baseinteger" ) if not isinstance ( timeout_ms , baseinteger ) : raise TypeError ( "timeout_ms can only be an instance of type baseinteger" ) data = self . _call ( "readAt" , in_p = [ offset , to_read , timeout_ms ] ) return data
Reads data from an offset of this file .
8,958
def set_acl ( self , acl , mode ) : if not isinstance ( acl , basestring ) : raise TypeError ( "acl can only be an instance of type basestring" ) if not isinstance ( mode , baseinteger ) : raise TypeError ( "mode can only be an instance of type baseinteger" ) self . _call ( "setACL" , in_p = [ acl , mode ] )
Sets the ACL of this file .
8,959
def set_size ( self , size ) : if not isinstance ( size , baseinteger ) : raise TypeError ( "size can only be an instance of type baseinteger" ) self . _call ( "setSize" , in_p = [ size ] )
Changes the file size .
8,960
def internal_get_statistics ( self ) : ( cpu_user , cpu_kernel , cpu_idle , mem_total , mem_free , mem_balloon , mem_shared , mem_cache , paged_total , mem_alloc_total , mem_free_total , mem_balloon_total , mem_shared_total ) = self . _call ( "internalGetStatistics" ) return ( cpu_user , cpu_kernel , cpu_idle , mem_total , mem_free , mem_balloon , mem_shared , mem_cache , paged_total , mem_alloc_total , mem_free_total , mem_balloon_total , mem_shared_total )
Internal method ; do not use as it might change at any time .
8,961
def get_facility_status ( self , facility ) : if not isinstance ( facility , AdditionsFacilityType ) : raise TypeError ( "facility can only be an instance of type AdditionsFacilityType" ) ( status , timestamp ) = self . _call ( "getFacilityStatus" , in_p = [ facility ] ) status = AdditionsFacilityStatus ( status ) return ( status , timestamp )
Get the current status of a Guest Additions facility .
8,962
def get_additions_status ( self , level ) : if not isinstance ( level , AdditionsRunLevelType ) : raise TypeError ( "level can only be an instance of type AdditionsRunLevelType" ) active = self . _call ( "getAdditionsStatus" , in_p = [ level ] ) return active
Retrieve the current status of a certain Guest Additions run level .
8,963
def set_credentials ( self , user_name , password , domain , allow_interactive_logon ) : if not isinstance ( user_name , basestring ) : raise TypeError ( "user_name can only be an instance of type basestring" ) if not isinstance ( password , basestring ) : raise TypeError ( "password can only be an instance of type basestring" ) if not isinstance ( domain , basestring ) : raise TypeError ( "domain can only be an instance of type basestring" ) if not isinstance ( allow_interactive_logon , bool ) : raise TypeError ( "allow_interactive_logon can only be an instance of type bool" ) self . _call ( "setCredentials" , in_p = [ user_name , password , domain , allow_interactive_logon ] )
Store login credentials that can be queried by guest operating systems with Additions installed . The credentials are transient to the session and the guest may also choose to erase them . Note that the caller cannot determine whether the guest operating system has queried or made use of the credentials .
8,964
def find_session ( self , session_name ) : if not isinstance ( session_name , basestring ) : raise TypeError ( "session_name can only be an instance of type basestring" ) sessions = self . _call ( "findSession" , in_p = [ session_name ] ) sessions = [ IGuestSession ( a ) for a in sessions ] return sessions
Finds guest sessions by their friendly name and returns an interface array with all found guest sessions .
8,965
def set_ids ( self , set_image_id , image_id , set_parent_id , parent_id ) : if not isinstance ( set_image_id , bool ) : raise TypeError ( "set_image_id can only be an instance of type bool" ) if not isinstance ( image_id , basestring ) : raise TypeError ( "image_id can only be an instance of type basestring" ) if not isinstance ( set_parent_id , bool ) : raise TypeError ( "set_parent_id can only be an instance of type bool" ) if not isinstance ( parent_id , basestring ) : raise TypeError ( "parent_id can only be an instance of type basestring" ) self . _call ( "setIds" , in_p = [ set_image_id , image_id , set_parent_id , parent_id ] )
Changes the UUID and parent UUID for a hard disk medium .
8,966
def check_encryption_password ( self , password ) : if not isinstance ( password , basestring ) : raise TypeError ( "password can only be an instance of type basestring" ) self . _call ( "checkEncryptionPassword" , in_p = [ password ] )
Checks whether the supplied password is correct for the medium .
8,967
def write ( self , offset , data ) : if not isinstance ( offset , baseinteger ) : raise TypeError ( "offset can only be an instance of type baseinteger" ) if not isinstance ( data , list ) : raise TypeError ( "data can only be an instance of type list" ) for a in data [ : 10 ] : if not isinstance ( a , basestring ) : raise TypeError ( "array can only contain objects of type basestring" ) written = self . _call ( "write" , in_p = [ offset , data ] ) return written
Write data to the medium .
8,968
def format_fat ( self , quick ) : if not isinstance ( quick , bool ) : raise TypeError ( "quick can only be an instance of type bool" ) self . _call ( "formatFAT" , in_p = [ quick ] )
Formats the medium as FAT . Generally only useful for floppy images as no partition table will be created .
8,969
def initialize_partition_table ( self , format_p , whole_disk_in_one_entry ) : if not isinstance ( format_p , PartitionTableType ) : raise TypeError ( "format_p can only be an instance of type PartitionTableType" ) if not isinstance ( whole_disk_in_one_entry , bool ) : raise TypeError ( "whole_disk_in_one_entry can only be an instance of type bool" ) self . _call ( "initializePartitionTable" , in_p = [ format_p , whole_disk_in_one_entry ] )
Writes an empty partition table to the disk .
8,970
def put_scancode ( self , scancode ) : if not isinstance ( scancode , baseinteger ) : raise TypeError ( "scancode can only be an instance of type baseinteger" ) self . _call ( "putScancode" , in_p = [ scancode ] )
Sends a scancode to the keyboard .
8,971
def put_scancodes ( self , scancodes ) : if not isinstance ( scancodes , list ) : raise TypeError ( "scancodes can only be an instance of type list" ) for a in scancodes [ : 10 ] : if not isinstance ( a , baseinteger ) : raise TypeError ( "array can only contain objects of type baseinteger" ) codes_stored = self . _call ( "putScancodes" , in_p = [ scancodes ] ) return codes_stored
Sends an array of scancodes to the keyboard .
8,972
def put_mouse_event ( self , dx , dy , dz , dw , button_state ) : if not isinstance ( dx , baseinteger ) : raise TypeError ( "dx can only be an instance of type baseinteger" ) if not isinstance ( dy , baseinteger ) : raise TypeError ( "dy can only be an instance of type baseinteger" ) if not isinstance ( dz , baseinteger ) : raise TypeError ( "dz can only be an instance of type baseinteger" ) if not isinstance ( dw , baseinteger ) : raise TypeError ( "dw can only be an instance of type baseinteger" ) if not isinstance ( button_state , baseinteger ) : raise TypeError ( "button_state can only be an instance of type baseinteger" ) self . _call ( "putMouseEvent" , in_p = [ dx , dy , dz , dw , button_state ] )
Initiates a mouse event using relative pointer movements along x and y axis .
8,973
def query_bitmap_info ( self ) : ( address , width , height , bits_per_pixel , bytes_per_line , bitmap_format ) = self . _call ( "queryBitmapInfo" ) bitmap_format = BitmapFormat ( bitmap_format ) return ( address , width , height , bits_per_pixel , bytes_per_line , bitmap_format )
Information about the screen bitmap .
8,974
def notify_update ( self , x , y , width , height ) : if not isinstance ( x , baseinteger ) : raise TypeError ( "x can only be an instance of type baseinteger" ) if not isinstance ( y , baseinteger ) : raise TypeError ( "y can only be an instance of type baseinteger" ) if not isinstance ( width , baseinteger ) : raise TypeError ( "width can only be an instance of type baseinteger" ) if not isinstance ( height , baseinteger ) : raise TypeError ( "height can only be an instance of type baseinteger" ) self . _call ( "notifyUpdate" , in_p = [ x , y , width , height ] )
Informs about an update . Gets called by the display object where this buffer is registered .
8,975
def notify_update_image ( self , x , y , width , height , image ) : if not isinstance ( x , baseinteger ) : raise TypeError ( "x can only be an instance of type baseinteger" ) if not isinstance ( y , baseinteger ) : raise TypeError ( "y can only be an instance of type baseinteger" ) if not isinstance ( width , baseinteger ) : raise TypeError ( "width can only be an instance of type baseinteger" ) if not isinstance ( height , baseinteger ) : raise TypeError ( "height can only be an instance of type baseinteger" ) if not isinstance ( image , list ) : raise TypeError ( "image can only be an instance of type list" ) for a in image [ : 10 ] : if not isinstance ( a , basestring ) : raise TypeError ( "array can only contain objects of type basestring" ) self . _call ( "notifyUpdateImage" , in_p = [ x , y , width , height , image ] )
Informs about an update and provides 32bpp bitmap .
8,976
def notify_change ( self , screen_id , x_origin , y_origin , width , height ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( x_origin , baseinteger ) : raise TypeError ( "x_origin can only be an instance of type baseinteger" ) if not isinstance ( y_origin , baseinteger ) : raise TypeError ( "y_origin can only be an instance of type baseinteger" ) if not isinstance ( width , baseinteger ) : raise TypeError ( "width can only be an instance of type baseinteger" ) if not isinstance ( height , baseinteger ) : raise TypeError ( "height can only be an instance of type baseinteger" ) self . _call ( "notifyChange" , in_p = [ screen_id , x_origin , y_origin , width , height ] )
Requests a size change .
8,977
def notify3_d_event ( self , type_p , data ) : if not isinstance ( type_p , baseinteger ) : raise TypeError ( "type_p can only be an instance of type baseinteger" ) if not isinstance ( data , list ) : raise TypeError ( "data can only be an instance of type list" ) for a in data [ : 10 ] : if not isinstance ( a , basestring ) : raise TypeError ( "array can only contain objects of type basestring" ) self . _call ( "notify3DEvent" , in_p = [ type_p , data ] )
Notifies framebuffer about 3D backend event .
8,978
def move ( self , x , y ) : if not isinstance ( x , baseinteger ) : raise TypeError ( "x can only be an instance of type baseinteger" ) if not isinstance ( y , baseinteger ) : raise TypeError ( "y can only be an instance of type baseinteger" ) self . _call ( "move" , in_p = [ x , y ] )
Changes the overlay s position relative to the IFramebuffer .
8,979
def attach_framebuffer ( self , screen_id , framebuffer ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( framebuffer , IFramebuffer ) : raise TypeError ( "framebuffer can only be an instance of type IFramebuffer" ) id_p = self . _call ( "attachFramebuffer" , in_p = [ screen_id , framebuffer ] ) return id_p
Sets the graphics update target for a screen .
8,980
def detach_framebuffer ( self , screen_id , id_p ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( id_p , basestring ) : raise TypeError ( "id_p can only be an instance of type basestring" ) self . _call ( "detachFramebuffer" , in_p = [ screen_id , id_p ] )
Removes the graphics updates target for a screen .
8,981
def query_framebuffer ( self , screen_id ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) framebuffer = self . _call ( "queryFramebuffer" , in_p = [ screen_id ] ) framebuffer = IFramebuffer ( framebuffer ) return framebuffer
Queries the graphics updates targets for a screen .
8,982
def take_screen_shot_to_array ( self , screen_id , width , height , bitmap_format ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( width , baseinteger ) : raise TypeError ( "width can only be an instance of type baseinteger" ) if not isinstance ( height , baseinteger ) : raise TypeError ( "height can only be an instance of type baseinteger" ) if not isinstance ( bitmap_format , BitmapFormat ) : raise TypeError ( "bitmap_format can only be an instance of type BitmapFormat" ) screen_data = self . _call ( "takeScreenShotToArray" , in_p = [ screen_id , width , height , bitmap_format ] ) return screen_data
Takes a guest screen shot of the requested size and format and returns it as an array of bytes .
8,983
def draw_to_screen ( self , screen_id , address , x , y , width , height ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( address , basestring ) : raise TypeError ( "address can only be an instance of type basestring" ) if not isinstance ( x , baseinteger ) : raise TypeError ( "x can only be an instance of type baseinteger" ) if not isinstance ( y , baseinteger ) : raise TypeError ( "y can only be an instance of type baseinteger" ) if not isinstance ( width , baseinteger ) : raise TypeError ( "width can only be an instance of type baseinteger" ) if not isinstance ( height , baseinteger ) : raise TypeError ( "height can only be an instance of type baseinteger" ) self . _call ( "drawToScreen" , in_p = [ screen_id , address , x , y , width , height ] )
Draws a 32 - bpp image of the specified size from the given buffer to the given point on the VM display .
8,984
def invalidate_and_update_screen ( self , screen_id ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) self . _call ( "invalidateAndUpdateScreen" , in_p = [ screen_id ] )
Redraw the specified VM screen .
8,985
def complete_vhwa_command ( self , command ) : if not isinstance ( command , basestring ) : raise TypeError ( "command can only be an instance of type basestring" ) self . _call ( "completeVHWACommand" , in_p = [ command ] )
Signals that the Video HW Acceleration command has completed .
8,986
def viewport_changed ( self , screen_id , x , y , width , height ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( x , baseinteger ) : raise TypeError ( "x can only be an instance of type baseinteger" ) if not isinstance ( y , baseinteger ) : raise TypeError ( "y can only be an instance of type baseinteger" ) if not isinstance ( width , baseinteger ) : raise TypeError ( "width can only be an instance of type baseinteger" ) if not isinstance ( height , baseinteger ) : raise TypeError ( "height can only be an instance of type baseinteger" ) self . _call ( "viewportChanged" , in_p = [ screen_id , x , y , width , height ] )
Signals that framebuffer window viewport has changed .
8,987
def query_source_bitmap ( self , screen_id ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) display_source_bitmap = self . _call ( "querySourceBitmap" , in_p = [ screen_id ] ) display_source_bitmap = IDisplaySourceBitmap ( display_source_bitmap ) return display_source_bitmap
Obtains the guest screen bitmap parameters .
8,988
def notify_scale_factor_change ( self , screen_id , u32_scale_factor_w_multiplied , u32_scale_factor_h_multiplied ) : if not isinstance ( screen_id , baseinteger ) : raise TypeError ( "screen_id can only be an instance of type baseinteger" ) if not isinstance ( u32_scale_factor_w_multiplied , baseinteger ) : raise TypeError ( "u32_scale_factor_w_multiplied can only be an instance of type baseinteger" ) if not isinstance ( u32_scale_factor_h_multiplied , baseinteger ) : raise TypeError ( "u32_scale_factor_h_multiplied can only be an instance of type baseinteger" ) self . _call ( "notifyScaleFactorChange" , in_p = [ screen_id , u32_scale_factor_w_multiplied , u32_scale_factor_h_multiplied ] )
Notify OpenGL HGCM host service about graphics content scaling factor change .
8,989
def notify_hi_dpi_output_policy_change ( self , f_unscaled_hi_dpi ) : if not isinstance ( f_unscaled_hi_dpi , bool ) : raise TypeError ( "f_unscaled_hi_dpi can only be an instance of type bool" ) self . _call ( "notifyHiDPIOutputPolicyChange" , in_p = [ f_unscaled_hi_dpi ] )
Notify OpenGL HGCM host service about HiDPI monitor scaling policy change .
8,990
def set_screen_layout ( self , screen_layout_mode , guest_screen_info ) : if not isinstance ( screen_layout_mode , ScreenLayoutMode ) : raise TypeError ( "screen_layout_mode can only be an instance of type ScreenLayoutMode" ) if not isinstance ( guest_screen_info , list ) : raise TypeError ( "guest_screen_info can only be an instance of type list" ) for a in guest_screen_info [ : 10 ] : if not isinstance ( a , IGuestScreenInfo ) : raise TypeError ( "array can only contain objects of type IGuestScreenInfo" ) self . _call ( "setScreenLayout" , in_p = [ screen_layout_mode , guest_screen_info ] )
Set video modes for the guest screens .
8,991
def detach_screens ( self , screen_ids ) : if not isinstance ( screen_ids , list ) : raise TypeError ( "screen_ids can only be an instance of type list" ) for a in screen_ids [ : 10 ] : if not isinstance ( a , baseinteger ) : raise TypeError ( "array can only contain objects of type baseinteger" ) self . _call ( "detachScreens" , in_p = [ screen_ids ] )
Unplugs monitors from the virtual graphics card .
8,992
def create_guest_screen_info ( self , display , status , primary , change_origin , origin_x , origin_y , width , height , bits_per_pixel ) : if not isinstance ( display , baseinteger ) : raise TypeError ( "display can only be an instance of type baseinteger" ) if not isinstance ( status , GuestMonitorStatus ) : raise TypeError ( "status can only be an instance of type GuestMonitorStatus" ) if not isinstance ( primary , bool ) : raise TypeError ( "primary can only be an instance of type bool" ) if not isinstance ( change_origin , bool ) : raise TypeError ( "change_origin can only be an instance of type bool" ) if not isinstance ( origin_x , baseinteger ) : raise TypeError ( "origin_x can only be an instance of type baseinteger" ) if not isinstance ( origin_y , baseinteger ) : raise TypeError ( "origin_y can only be an instance of type baseinteger" ) if not isinstance ( width , baseinteger ) : raise TypeError ( "width can only be an instance of type baseinteger" ) if not isinstance ( height , baseinteger ) : raise TypeError ( "height can only be an instance of type baseinteger" ) if not isinstance ( bits_per_pixel , baseinteger ) : raise TypeError ( "bits_per_pixel can only be an instance of type baseinteger" ) guest_screen_info = self . _call ( "createGuestScreenInfo" , in_p = [ display , status , primary , change_origin , origin_x , origin_y , width , height , bits_per_pixel ] ) guest_screen_info = IGuestScreenInfo ( guest_screen_info ) return guest_screen_info
Make a IGuestScreenInfo object with the provided parameters .
8,993
def modify_log_groups ( self , settings ) : if not isinstance ( settings , basestring ) : raise TypeError ( "settings can only be an instance of type basestring" ) self . _call ( "modifyLogGroups" , in_p = [ settings ] )
Modifies the group settings of the debug or release logger .
8,994
def modify_log_flags ( self , settings ) : if not isinstance ( settings , basestring ) : raise TypeError ( "settings can only be an instance of type basestring" ) self . _call ( "modifyLogFlags" , in_p = [ settings ] )
Modifies the debug or release logger flags .
8,995
def modify_log_destinations ( self , settings ) : if not isinstance ( settings , basestring ) : raise TypeError ( "settings can only be an instance of type basestring" ) self . _call ( "modifyLogDestinations" , in_p = [ settings ] )
Modifies the debug or release logger destinations .
8,996
def load_plug_in ( self , name ) : if not isinstance ( name , basestring ) : raise TypeError ( "name can only be an instance of type basestring" ) plug_in_name = self . _call ( "loadPlugIn" , in_p = [ name ] ) return plug_in_name
Loads a DBGF plug - in .
8,997
def unload_plug_in ( self , name ) : if not isinstance ( name , basestring ) : raise TypeError ( "name can only be an instance of type basestring" ) self . _call ( "unloadPlugIn" , in_p = [ name ] )
Unloads a DBGF plug - in .
8,998
def get_register ( self , cpu_id , name ) : if not isinstance ( cpu_id , baseinteger ) : raise TypeError ( "cpu_id can only be an instance of type baseinteger" ) if not isinstance ( name , basestring ) : raise TypeError ( "name can only be an instance of type basestring" ) value = self . _call ( "getRegister" , in_p = [ cpu_id , name ] ) return value
Gets one register .
8,999
def get_registers ( self , cpu_id ) : if not isinstance ( cpu_id , baseinteger ) : raise TypeError ( "cpu_id can only be an instance of type baseinteger" ) ( names , values ) = self . _call ( "getRegisters" , in_p = [ cpu_id ] ) return ( names , values )
Gets all the registers for the given CPU .