Package prlsdkapi :: Class VmConfig
[hide private]
[frames] | no frames]

Class VmConfig

object --+    
         |    
   _Handle --+
             |
            VmConfig
Known Subclasses:

Provides methods for managing the configuration of a virtual machine.

Instance Methods [hide private]
 
set_network_rate_list(self, hNetworkRateList)
 
get_network_rate_list(self)
 
is_rate_bound(self)
 
set_rate_bound(self, bEnabled)
 
set_os_template(self, sOsTemplate)
 
get_os_template(self)
 
apply_config_sample(self, sConfigSample)
 
get_app_template_list(self)
 
set_app_template_list(self, hAppList)
 
set_default_config(self, hSrvConfig, guestOsVersion, needCreateDevices)
Set the default configuration for a new virtual machine based on the guest OS type.
 
is_config_invalid(self, nErrCode)
 
get_config_validity(self)
Return a constant indicating the virtual machine configuration validity.
 
add_default_device(self, hSrvConfig, deviceType)
Automates the task of setting devices in a virtual machine.
 
add_default_device_ex(self, hSrvConfig, deviceType)
 
is_default_device_needed(self, guestOsVersion, deviceType)
Determine whether a default virtual device is needed for running the OS of the specified type.
 
get_default_mem_size(self, guestOsVersion, hostRam)
Return the default RAM size for to the specified OS type and version.
 
get_default_hdd_size(self, guestOsVersion)
Return the default hard disk size for to the specified OS type and version.
 
get_default_video_ram_size(self, guestOsVersion, hSrvConfig, bIs3DSupportEnabled)
Return the default video RAM size for the specified OS type and version.
 
create_vm_dev(self, nDeviceType)
Create a new virtual device handle of the specified type.
 
get_access_rights(self)
Obtain the AccessRights object.
 
get_devs_count(self)
Determine the total number of devices of all types installed in the virtual machine.
 
get_all_devices(self)
Obtains objects for all virtual devices in a virtual machine.
 
get_devs_count_by_type(self, vmDeviceType)
Obtain the number of virtual devices of the specified type.
 
get_dev_by_type(self, vmDeviceType, nIndex)
Obtains a virtual device object according to the specified device type and index.
 
get_floppy_disks_count(self)
Determine the number of floppy disk drives in a virtual machine.
 
get_floppy_disk(self, nIndex)
Obtain the VmDevice object containing information about a floppy disk drive in a vrtiual machine.
 
get_hard_disks_count(self)
Determines the number of virtual hard disks in a virtual machine.
 
get_hard_disk(self, nIndex)
Obtain the VmHardDisk object containing the specified virtual hard disk information.
 
get_optical_disks_count(self)
Determine the number of optical disks in the specified virtual machine.
 
get_optical_disk(self, nIndex)
Obtain the VmDevice object containing information about a virtual optical disk.
 
get_parallel_ports_count(self)
Determine the number of virtual parallel ports in the virtual machine.
 
get_parallel_port(self, nIndex)
Obtains the VmDevice object containing information about a virtual parallel port.
 
get_serial_ports_count(self)
Determine the number of serial ports in a virtual machine.
 
get_serial_port(self, nIndex)
Obtain the VmSerial object containing information about a serial port in a virtual machine.
 
get_sound_devs_count(self)
Determine the number of sound devices in a virtual machine.
 
get_sound_dev(self, nIndex)
Obtain the VmSound object containing information about a sound device in a virtual machine.
 
get_usb_devices_count(self)
Determine the number of USB devices in a virtual machine.
 
get_usb_device(self, nIndex)
Obtain the VmUsb object containing information about a USB device in the virtual machine.
 
get_net_adapters_count(self)
Determine the number of network adapters in a virtual machine.
 
get_net_adapter(self, nIndex)
Obtain the VmNet object containing information about a virtual network adapter.
 
get_generic_pci_devs_count(self)
Determines the number of generic PCI devices in a virtual machine.
 
get_generic_pci_dev(self, nIndex)
Obtain the VmDevice object containing information about a generic PCI device.
 
get_generic_scsi_devs_count(self)
Determines the number of generic SCSI devices in a virtual machine.
 
get_generic_scsi_dev(self, nIndex)
Obtain the VmDevice object containing information about a SCSI device in a virtual machine.
 
get_display_devs_count(self)
Determine the number of display devices in a virtual machine.
 
get_display_dev(self, nIndex)
Obtains the VmDevice containing information about a display device in a virtual machine.
 
create_share(self)
Create a new instance of Share and add it to the virtual machine list of shares.
 
get_shares_count(self)
Determine the number of shared folders in a virtual machine.
 
get_share(self, nShareIndex)
Obtain the Share object containing information about a shared folder.
 
is_smart_guard_enabled(self)
Determine whether the SmartGuard feature is enabled in the virtual machine.
 
set_smart_guard_enabled(self, bEnabled)
Enable the SmartGuard feature in the virtual machine.
 
is_smart_guard_notify_before_creation(self)
Determine whether the user will be notified on automatic snapshot creation by SmartGaurd.
 
set_smart_guard_notify_before_creation(self, bNotifyBeforeCreation)
Enable or disable notification of automatic snapshot creation, a SmartGuard feature.
 
get_smart_guard_interval(self)
Determines the interval at which snapshots are taken by SmartGuard.
 
set_smart_guard_interval(self, nInterval)
Set the time interval at which snapshots are taken by SmartGuard.
 
get_smart_guard_max_snapshots_count(self)
Determines the maximum snapshot count, a SmartGuard setting.
 
set_smart_guard_max_snapshots_count(self, nMaxSnapshotsCount)
Set the maximum snapshot count, a SmartGuard feature.
 
is_user_defined_shared_folders_enabled(self)
Determine whether the user-defined shared folders are enabled or not.
 
set_user_defined_shared_folders_enabled(self, bEnabled)
Enables or disables user-defined shared folders.
 
is_smart_mount_enabled(self)
 
set_smart_mount_enabled(self, bEnabled)
 
is_smart_mount_removable_drives_enabled(self)
 
set_smart_mount_removable_drives_enabled(self, bEnabled)
 
is_smart_mount_dvds_enabled(self)
 
set_smart_mount_dvds_enabled(self, bEnabled)
 
is_smart_mount_network_shares_enabled(self)
 
set_smart_mount_network_shares_enabled(self, bEnabled)
 
is_shared_profile_enabled(self)
Determine whether the Shared Profile feature is enabled in the virtual machine.
 
set_shared_profile_enabled(self, bEnabled)
Enable or disable the Shared Profile feature in the virtual machine.
 
is_use_desktop(self)
Determine whether the 'use desktop in share profile' feature is enabled or not.
 
set_use_desktop(self, bEnabled)
Enable or disable the 'undo-desktop' feature in the shared profile.
 
is_use_documents(self)
Determine whether 'use documents in shared profile' feature is enabled or not.
 
set_use_documents(self, bEnabled)
Enable or disable the 'use documents in shared profile' feature.
 
is_use_pictures(self)
Determine whether the 'used pictures in shared profile' feature is enabled or not.
 
set_use_pictures(self, bEnabled)
Enables or disables the 'use pictures in shared profile' feature.
 
is_use_music(self)
Determine whether the 'use music in shared profile' feature is enabled or not.
 
set_use_music(self, bEnabled)
Enables or disables the 'use music in shared profile' feature.
 
is_use_downloads(self)
 
set_use_downloads(self, bEnabled)
 
is_use_movies(self)
 
set_use_movies(self, bEnabled)
 
get_optimize_modifiers_mode(self)
 
set_optimize_modifiers_mode(self, nMode)
 
is_share_clipboard(self)
Determine whether the clipboard sharing feature is enabled in the virtual machine.
 
set_share_clipboard(self, bEnabled)
Enable or disable the clipboard sharing feature.
 
is_offline_management_enabled(self)
Determine whether the offline management feature is enabled for the virtual machine.
 
set_offline_management_enabled(self, bEnabled)
Enables or disables the offline management feature for the virtual machine.
 
is_tools_auto_update_enabled(self)
Enables or disables the Virtuozzo Tools AutoUpdate feature for the virtual machine.
 
set_tools_auto_update_enabled(self, bEnabled)
Enable or disable the Virtuozzo Tools AutoUpdate feature for the virtual machine.
 
is_time_synchronization_enabled(self)
Determine whether the time synchronization feature is enabled in the virtual machine.
 
set_time_synchronization_enabled(self, bEnabled)
Enable or disable the time synchronization feature in a virtual machine.
 
is_time_sync_smart_mode_enabled(self)
Determine whether the smart time synchronization is enabled in a virtual machine.
 
set_time_sync_smart_mode_enabled(self, bEnabled)
Enable or disable the smart time-synchronization mode in the virtual machine.
 
get_time_sync_interval(self)
Obtain the time synchronization interval between the host and the guest OS.
 
set_time_sync_interval(self, nTimeSyncInterval)
Set the time interval at which time in the virtual machine will be synchronized with the host OS.
 
is_allow_select_boot_device(self)
Determine whether the 'select boot device' option is shown on virtual machine startup.
 
set_allow_select_boot_device(self, bAllowed)
Switch on/off the 'select boot device' dialog on virtual machine startup.
 
create_boot_dev(self)
Create a new instance of BootDevice and add it to the virtual machine boot device list.
 
get_boot_dev_count(self)
Determine the number of devices in the virtual machine boot device priority list.
 
get_boot_dev(self, nBootDevIndex)
Obtain the BootDevice object containing information about a specified boot device.
 
get_name(self)
Return the virtual machine name.
 
set_name(self, sNewVmName)
Set the virtual machine name.
 
get_hostname(self)
Obtain the hostname of the specified virtual machine.
 
set_hostname(self, sNewVmHostname)
Set the virtual machine hostname.
 
get_dns_servers(self)
 
set_dns_servers(self, hDnsServersList)
 
get_uuid(self)
Return the UUID (universally unique ID) of the virtual machine.
 
set_uuid(self, sNewVmUuid)
Set the virtual machine UUID (universally unique ID).
 
get_ct_id(self)
 
get_linked_vm_uuid(self)
 
get_os_type(self)
Return the type of the operating system that the specified virtual machine is running.
 
get_os_version(self)
Return the version of the operating system that the specified virtual machine is running.
 
set_os_version(self, nVmOsVersion)
Set the virtual machine guest OS version.
 
get_ram_size(self)
Return the virtual machine memory (RAM) size, in megabytes.
 
set_ram_size(self, nVmRamSize)
Sets the virtual machine memory (RAM) size.
 
get_video_ram_size(self)
Return the video memory size of the virtual machine.
 
set_video_ram_size(self, nVmVideoRamSize)
Set the virtual machine video memory size.
 
get_mem_guarantee_size(self)
 
set_mem_guarantee_size(self, nType, nValue)
 
get_cpu_count(self)
Determine the number of CPUs in the virtual machine.
 
set_cpu_count(self, nVmCpuCount)
Set the number of CPUs for the virtual machine (the CPUs should be present in the machine).
 
get_cpu_mode(self)
Determine the specified virtual machine CPU mode (32 bit or 64 bit).
 
set_cpu_mode(self, nVmCpuMode)
Set CPU mode (32 bit or 64 bit) for the virtual machine.
 
get_cpu_accel_level(self)
Determine the virtual machine CPU acceleration level.
 
set_cpu_accel_level(self, nVmCpuAccelLevel)
Set CPU acceleration level for the virtual machine.
 
is_cpu_vtx_enabled(self)
Determine whether the x86 virtualization (such as Vt-x) is available in the virtual machine CPU.
 
is_cpu_hotplug_enabled(self)
 
set_cpu_hotplug_enabled(self, bVmCpuHotplugEnabled)
 
get3dacceleration_mode(self)
 
set3dacceleration_mode(self, n3DAccelerationMode)
 
is_vertical_synchronization_enabled(self)
 
set_vertical_synchronization_enabled(self, bEnabled)
 
is_high_resolution_enabled(self)
 
set_high_resolution_enabled(self, bEnabled)
 
is_adaptive_hypervisor_enabled(self)
 
set_adaptive_hypervisor_enabled(self, bEnable)
 
is_switch_off_windows_logo_enabled(self)
 
set_switch_off_windows_logo_enabled(self, bEnable)
 
is_longer_battery_life_enabled(self)
 
set_longer_battery_life_enabled(self, bEnable)
 
is_battery_status_enabled(self)
 
set_battery_status_enabled(self, bEnable)
 
is_nested_virtualization_enabled(self)
 
set_nested_virtualization_enabled(self, bEnable)
 
is_pmuvirtualization_enabled(self)
 
set_pmuvirtualization_enabled(self, bEnable)
 
is_lock_guest_on_suspend_enabled(self)
 
set_lock_guest_on_suspend_enabled(self, bEnable)
 
is_isolated_vm_enabled(self)
 
set_isolated_vm_enabled(self, bEnable)
 
set_cpu_units(self, nVmCpuUnits)
Set the number of CPU units that will be allocated to a virtual machine.
 
get_cpu_units(self)
Determine the number of CPU units allocated to a virtual machine.
 
set_cpu_limit(self, nVmCpuLimit)
Set the CPU usage limit (in percent) for a virtual machine.
 
get_cpu_limit(self)
Determine the CPU usage limit of a virtual machine, in percent.
 
get_cpu_mask(self)
 
set_cpu_mask(self, sMask)
 
get_node_mask(self)
 
set_node_mask(self, sMask)
 
get_io_priority(self)
Determines the specified virtual machine I/O priority.
 
set_io_priority(self, nVmIoPriority)
Set the virtual machine I/O priority.
 
get_io_limit(self)
 
set_io_limit(self, nValue)
 
get_iops_limit(self)
 
set_iops_limit(self, nVmIopsLimit)
 
get_server_uuid(self)
Returns the UUID of the machine hosting the specified virtual machine.
 
get_server_host(self)
Return the hostname of the machine hosting the specified virtual machine.
 
get_home_path(self)
Return the virtual machine home directory name and path.
 
get_location(self)
 
get_icon(self)
Return the name of the icon file used by the specified virtual machine.
 
set_icon(self, sNewVmIcon)
Set the virtual machine icon.
 
get_description(self)
Return the virtual machine description.
 
set_description(self, sNewVmDescription)
Set the virtual machine description.
 
is_template(self)
Determine whether the virtual machine is a real machine or a template.
 
set_template_sign(self, bVmIsTemplate)
Modify a regular virtual machine to become a template, and vise versa.
 
get_custom_property(self)
Return the virtual machine custom property information.
 
set_custom_property(self, sNewVmCustomProperty)
Set the virtual machine custom property information.
 
get_auto_start(self)
Determine if the specified virtual machine is set to start automatically on Virtuozzo Service start.
 
set_auto_start(self, nVmAutoStart)
Set the automatic startup option for the virtual machine.
 
get_auto_start_delay(self)
Returns the time delay used during the virtual machine automatic startup.
 
set_auto_start_delay(self, nVmAutoStartDelay)
Set the time delay that will be used during the virtual machine automatic startup.
 
get_start_login_mode(self)
Return the automatic startup login mode for the virtual machine.
 
set_start_login_mode(self, nVmStartLoginMode)
Set the automatic startup login mode for the specified virtual machine.
 
get_start_user_login(self)
Return the user name used during the virtual machine automatic startup.
 
set_start_user_creds(self, sStartUserLogin, sPassword)
Sset the automatic startup user login and password for the virtual machine.
 
get_auto_stop(self)
Determine the mode of the automatic shutdown for the specified virtual machine.
 
set_auto_stop(self, nVmAutoStop)
Set the automatic shutdown mode for the virtual machine.
 
get_action_on_window_close(self)
Determine the action on Virtuozzo Application window close for the specified virtual machine.
 
set_action_on_window_close(self, nActionOnWindowClose)
Set the action to perform on the Virtuozzo console window closing.
 
get_action_on_stop_mode(self)
 
set_action_on_stop_mode(self, nMode)
 
get_window_mode(self)
Return the current window mode the virtual machine is in.
 
set_window_mode(self, nVmWindowMode)
Sets the virtual machine window mode.
 
is_start_in_detached_window_enabled(self)
 
set_start_in_detached_window_enabled(self, bEnable)
 
is_lock_in_full_screen_mode(self)
Determine whether the 'lock in screen mode' flag is set in the virtual machine configuration.
 
set_lock_in_full_screen_mode(self, bValue)
Enable or disable the lock in screen mode feature in the virtual machine configuration.
 
get_last_modified_date(self)
Return the date and time when the specified virtual machine was last modified.
 
get_last_modifier_name(self)
Return the name of the user who last modified the specified virtual machine.
 
get_uptime_start_date(self)
Return the date and time when the uptime counter was started for the specified virtual machine.
 
get_uptime(self)
 
is_guest_sharing_enabled(self)
Determine if guest sharing is enabled (the guest OS disk drives are visible in the host OS).
 
set_guest_sharing_enabled(self, bVmGuestSharingEnabled)
Enables the guest sharing feature.
 
is_guest_sharing_auto_mount(self)
Determine if host shared folders are mounted automatically in the virtual machine.
 
set_guest_sharing_auto_mount(self, bVmGuestSharingAutoMount)
Set the guest OS sharing auto-mount option.
 
is_guest_sharing_enable_spotlight(self)
Determine if the virtual disks will be added to Spotlight search subsystem (Mac OS X feature).
 
set_guest_sharing_enable_spotlight(self, bVmGuestSharingEnableSpotlight)
Set whether the virtual disks are added to Spotlight search subsystem.
 
is_host_sharing_enabled(self)
Determine if host sharing is enabled (host shared folders are visible in the guest OS).
 
set_host_sharing_enabled(self, bVmHostSharingEnabled)
Enable host sharing for the virtual machine.
 
is_share_all_host_disks(self)
Determine whether all host disks will be present in the guest OS as shares.
 
set_share_all_host_disks(self, bShareAllHostDisks)
Enable sharing of all host disks for the virtual machine.
 
is_share_user_home_dir(self)
Determine whether the host user home directory will be available in the guest OS as a share.
 
set_share_user_home_dir(self, bShareUserHomeDir)
Enable or disable sharing of the host user home directory in the specified virtual machine.
 
is_map_shared_folders_on_letters(self)
Determine whether host disks shared with the guest Windows OS will be mapped to drive letters.
 
set_map_shared_folders_on_letters(self, bMapSharedFoldersOnLetters)
Enable mapping of shared host disks to drive letters for the virtual machine.
 
get_vncmode(self)
Return the VNC mode of the virtual machine.
 
set_vncmode(self, nVmRemoteDisplayMode)
Set the virtual machine VNC mode.
 
get_vncpassword(self)
Return the VNC password for the virtual machine.
 
set_vncpassword(self, sNewVmRemoteDisplayPassword)
Set the virtual machine VNC password.
 
get_vnchost_name(self)
Return the VNC hostname of the virtual machine.
 
set_vnchost_name(self, sNewVmRemoteDisplayHostName)
Set the virtual machine VNC host name.
 
get_vncport(self)
Return the VNC port number for the virtual machine
 
set_vncport(self, nVmRemoteDisplayPort)
Set the virtual machine VNC port number.
 
get_vncweb_socket_port(self)
 
is_vncencryption_enabled(self)
 
is_scr_res_enabled(self)
Determine if additional screen resolution support is enabled in the virtual machine.
 
set_scr_res_enabled(self, bVmScrResEnabled)
Enable or disable the additional screen resolution support in the virtual machine.
 
is_disk_cache_write_back(self)
Determine if disk cache write-back is enabled in the virtual machine.
 
set_disk_cache_write_back(self, bVmDiskCacheWriteBack)
Set the virtual machine disk cache write-back option.
 
is_os_res_in_full_scr_mode(self)
Determines wether the virtual machine OS resolution is in full screen mode.
 
set_os_res_in_full_scr_mode(self, bVmOsResInFullScrMode)
Turn on/off the virtual machine OS resolution in full screen mode option.
 
is_close_app_on_shutdown(self)
Determine whether the Virtuozzo console app is automatically closed on the virtual machine shutdown.
 
set_close_app_on_shutdown(self, bVmCloseAppOnShutdown)
Set whether the Virtuozzo console app will be closed on the virtual machine shutdown.
 
get_system_flags(self)
Return the virtual machine system flags.
 
set_system_flags(self, sNewVmSystemFlags)
Set the virtual machine system flags.
 
is_disable_apic(self)
Determine whether the APIC is enabled during the virtual machine runtime.
 
set_disable_apicsign(self, bDisableAPIC)
Set whether the virtual machine should be using APIC during runtime.
 
is_disable_speaker(self)
 
set_disable_speaker_sign(self, bDisableSpeaker)
 
get_undo_disks_mode(self)
Determine the current undo-disks mode for the virtual machine.
 
set_undo_disks_mode(self, nUndoDisksMode)
Set the undo-disks mode for the virtual machine.
 
get_foreground_priority(self)
Return foreground processes priority for the specified virtual machine.
 
set_foreground_priority(self, nVmForegroundPriority)
Set the virtual machine foreground processes priority.
 
get_background_priority(self)
Determine the specified virtual machine background process priority type.
 
set_background_priority(self, nVmBackgroundPriority)
Set the virtual machine background processes priority.
 
is_use_default_answers(self)
Determine whether the use default answers mechanism is active in the virtual machine.
 
set_use_default_answers(self, bUseDefaultAnswers)
Enable the use default answers mechanism in a virtual machine.
 
get_search_domains(self)
Obtain the list of search domains that will be assigned to the guest OS.
 
set_search_domains(self, hSearchDomainsList)
Set the global search domain list that will be assigned to the guest OS.
 
get_offline_services(self)
Obtain the list of services available in the virtual machine offline management.
 
set_offline_services(self, hOfflineServicesList)
Set offline services that will be available in the virtual machine offline management.
 
get_confirmations_list(self)
Obtain a list of operations with virtual machine which requires administrator confirmation.
 
set_confirmations_list(self, hConfirmList)
Obtain the list of virtual machine operations that require administrator confirmation.
 
is_auto_compress_enabled(self)
Determine whether the Automatic HDD compression feature is enabled in the virtual machine.
 
set_auto_compress_enabled(self, bEnabled)
Enables or disables the Automatic HDD compression feature in the virtual machine.
 
get_auto_compress_interval(self)
Determine the interval at which compacting virtual disks is performed by Automatic HDD compression.
 
set_auto_compress_interval(self, nInterval)
Set the time interval at which compacting virtual disks is done by Automatic HDD compression.
 
get_free_disk_space_ratio(self)
Determine free disk space ratio at which disk compacting is done by Automatic HDD compression.
 
set_free_disk_space_ratio(self, dFreeDiskSpaceRatio)
Set the free disk space ratio at which compacting virtual disks is done by Automatic HDD compress.
 
get_vm_info(self)
 
get_vm_type(self)
 
set_vm_type(self, nType)
 
is_efi_enabled(self)
 
set_efi_enabled(self, bEfiEnabled)
 
get_external_boot_device(self)
 
set_external_boot_device(self, sNewSysName)
 
is_ram_hotplug_enabled(self)
 
set_ram_hotplug_enabled(self, bVmRamHotplugEnabled)
 
get_resource(self, nResourceId)
 
set_resource(self, nResourceId, nBarrirer, nLimit)
 
is_auto_apply_ip_only(self)
 
set_auto_apply_ip_only(self, bAutoApplyIpOnly)
 
get_capabilities_mask(self)
 
set_capabilities_mask(self, nCapMask)
 
get_netfilter_mode(self)
 
set_netfilter_mode(self, nMode)
 
get_features_mask(self)
 
set_features_mask(self, nOn, nOff)
 
set_high_availability_enabled(self, bEnabled)
 
is_high_availability_enabled(self)
 
set_high_availability_priority(self, nPriority)
 
get_high_availability_priority(self)
 
get_action_on_guest_crash(self)
 
set_action_on_guest_crash(self, nAction)
 
get_options_on_guest_crash(self)
 
set_options_on_guest_crash(self, nOptions)

Inherited from _Handle: __del__, __init__, add_ref, free, from_string, get_handle_type, get_package_id, get_type, reg_event_handler, unreg_event_handler

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

get_uptime_start_date(self)

 

Return the date and time when the uptime counter was started for the specified virtual machine. The date is returned using the yyyy-mm-dd hh:mi:ss format. The date is automatically converted to the local time zone.

Returns:
A string containing the date and time of the virtual machine uptime counter activation.