Package prlsdkapi :: Class Server

Class Server

object --+    
         |    
   _Handle --+
             |
            Server

The main class providing methods for accessing Parallels Service. Most of the operations in the Parallels Python API begin with obtaining an instance of this class. The class is used to establish a connection with the Parallels Service. Its other methods can be used to perform various tasks related to the Parallels Service itself, higher level virtual machine tasks, such as obtaining the virtual machine list or creating a virtual machine, and many others.

Instance Methods

[hide private]

__init__(self, handle=0)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

check_parallels_server_alive(self, timeout, sServerHostname)
Determine if the Parallels Service on the specified host is running.

create(self)
Create a new instance of the Server class.

login(self, host, user, passwd, sPrevSessionUuid='', port_cmd=0, timeout=0, security_level=2)
Login to a remote Parallels Service.

login_local(self, sPrevSessionUuid='', port=0, security_level=2)
Login to the local Parallels Service.

logoff(self)
Log off the Parallels Service.

get_questions(self)
Allows to synchronously receive questions from Parallels Service.

set_non_interactive_session(self, bNonInteractive, nFlags=0)
Set the session in noninteractive or interactive mode.

is_non_interactive_session(self)

disable_confirmation_mode(self, sUser, sPasswd, nFlags=0)
Disable administrator confirmation mode for the session.

enable_confirmation_mode(self, nFlags=0)
Enable administrator confirmation mode for the session.

is_confirmation_mode_enabled(self)
Determine confirmation mode for the session.

get_srv_config(self)
Obtain the ServerConfig object containing the host configuration information.

get_common_prefs(self)
Obtain the DispConfig object containing the specified Parallels Service preferences info.

common_prefs_begin_edit(self)
Mark the beginning of the Parallels Service preferences modification operation.

common_prefs_commit(self, hDispCfg)
Commit the Parallels Server preferences changes.

get_user_profile(self)
Obtain the UserConfig object containing profile data of the currently logged in user.

get_user_info_list(self)
Obtain a list of UserInfo objects containing information about all known users.

get_user_info(self, sUserId)
Obtain the UserInfo object containing information about the specified user.

get_virtual_network_list(self, nFlags=0)
Obtain the VirtualNet object containing information about all existing virtual networks.

add_virtual_network(self, hVirtNet, nFlags=0)
Add a new virtual network to the Parallels Service configuration.

update_virtual_network(self, hVirtNet, nFlags=0)
Update parameters of an existing virtual network.

delete_virtual_network(self, hVirtNet, nFlags=0)
Remove an existing virtual network from the Parallels Service configuration.

update_offline_service(self, hOffmgmtService, nFlags)

delete_offline_service(self, hOffmgmtService, nFlags)

get_offline_services_list(self, nFlags)

update_network_classes_list(self, hNetworkClassesList, nFlags)

get_network_classes_list(self, nFlags)

update_network_shaping_list(self, hNetworkShapingList, nFlags)

get_network_shaping_list(self, nFlags)

configure_generic_pci(self, hDevList, nFlags=0)
Configure the PCI device assignment.

get_statistics(self)
Obtain the Statistics object containing the host resource usage statistics.

user_profile_begin_edit(self)

user_profile_commit(self, hUserProfile)
Saves (commits) user profile changes to the Parallels Service.

is_connected(self)
Determine if the connection to the specified Parallels Service is active.

get_server_info(self)
Obtain the ServerInfo object containing the host computer information.

register_vm(self, strVmDirPath, bNonInteractiveMode=False)
Register an existing virtual machine with the Parallels Service.

register_vm_ex(self, strVmDirPath, nFlags)
Register an existing virtual machine with Parallels Service (extended version).

register3rd_party_vm(self, strVmConfigPath, strVmRootDirPath, nFlags)

create_vm(self)
Create a new instaince of the Vm class.

get_vm_list(self)
Obtain a list of virtual machines from the host.

create_vm_backup(self, sVmUuid, sTargetHost, nTargetPort, sTargetSessionId, strDescription='', backup_flags=2048, reserved_flags=0, force_operation=True)
Backup an existing virtual machine to a backup server.

restore_vm_backup(self, sVmUuid, sBackupUuid, sTargetHost, nTargetPort, sTargetSessionId, sTargetVmHomePath='', sTargetVmName='', restore_flags=0, reserved_flags=0, force_operation=True)
Restore a virtual machine from a backup server.

get_backup_tree(self, sVmUuid, sTargetHost, nTargetPort, sTargetSessionId, backup_flags=2048, reserved_flags=0, force_operation=True)
Get backups tree from backup server.

remove_vm_backup(self, sVmUuid, sBackupUuid, sTargetHost, nTargetPort, sTargetSessionId, remove_flags, reserved_flags, force_operation)
Remove backup of the virtual machine from the backup server.

subscribe_to_host_statistics(self)
Subscribe to receive host statistics.

unsubscribe_from_host_statistics(self)
Cancel the host statistics subscription.

shutdown(self, bForceShutdown=False)
Shut down the Parallels Service.

fs_get_disk_list(self)
Returns a list of root directories on the host computer.

fs_get_dir_entries(self, path)
Retrieve information about a file system entry on the host.

fs_create_dir(self, path)
Create a directory in the specified location on the host.

fs_remove_entry(self, path)
Remove a file system entry from the host computer.

fs_can_create_file(self, path)
Determine if the current user has rights to create a file on the host.

fs_rename_entry(self, oldPath, newPath)
Rename a file system entry on the host.

update_license(self, sKey, sUser, sCompany)
Installs Parallels license on the specified Parallels Service.

get_license_info(self)
Obtain the License object containing the Parallels license information.

send_answer(self, hAnswer)
Send an answer to the Parallels Service in response to a question.

start_search_vms(self, hStringsList=0)
Searche for unregistered virtual machines at the specified location(s).

net_service_start(self)
Start the Parallels network service.

net_service_stop(self)
Stop the Parallels network service.

net_service_restart(self)
Restarts the Parallels network service.

net_service_restore_defaults(self)
Restores the default settings of the Parallels network service.

get_net_service_status(self)
Obtain the NetService object containing the Parallels network service status information.

get_problem_report(self)
Obtain a problem report in the event of a virtual machine operation failure.

get_packed_problem_report(self, nFlags)

attach_to_lost_task(self, sTaskId)
Obtain a handle to a running task after the connection to the Parallels Service was lost.

get_supported_oses(self)

create_unattended_cd(self, nGuestType, sUserName, sPasswd, sFullUserName, sOsDistroPath, sOutImagePath)
Create a bootable ISO-image for unattended Linux installation.

fs_generate_entry_name(self, sDirPath, sFilenamePrefix='', sFilenameSuffix='', sIndexDelimiter='')
Automatically generate a unique name for a new directory.

subscribe_to_perf_stats(self, sFilter)
Subscribe to receive perfomance statistics.

unsubscribe_from_perf_stats(self)
Cancels the performance statistics subscription.

get_perf_stats(self, sFilter)

has_restriction(self, nRestrictionKey)

get_restriction_info(self, nRestrictionKey)

install_appliance(self, hAppCfg, sVmParentPath, nFlags)

cancel_install_appliance(self, hAppCfg, nFlags)

stop_install_appliance(self, hAppCfg, nFlags)

start_cluster_service(self, sServiceName, nFlags)

stop_cluster_service(self, sServiceName, nFlags)

Inherited from _Handle: __del__, add_ref, free, get_handle_type, get_type

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, handle=0)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

common_prefs_begin_edit(self)

Mark the beginning of the Parallels Service preferences modification operation. This method must be called before making any changes to the Parallels Service common preferences (see DispConfig). When you are done making the changes, call Server.common_prefs_commit to commit the changes.

register_vm(self, strVmDirPath, bNonInteractiveMode=False)

Parameters:

strVmDirPath - Name and path of the virtual machine directory.
bNonInteractiveMode - Set to True to use non-interactive mode. Set to False to use interactive mode.

Returns:

An instance of the Vm class containing information about the virtual machine that was registered.

create_vm(self)

Create a new instaince of the Vm class.

Returns:: A new instance of Vm.

get_vm_list(self)

Obtain a list of virtual machines from the host.

Returns:: A prlsdk.Result object containing a list of Vm instances. Individual Vm objects can be extracted using the prlsdkapi.Result.get_param method.

subscribe_to_host_statistics(self)

Subscribe to receive host statistics. This is an asynchronous method.

Returns:: A Job object.

unsubscribe_from_host_statistics(self)

Cancel the host statistics subscription. This is an asynchronous method.

Returns:: A Job object.

Class Server

__init__(self, handle=0) (Constructor)

common_prefs_begin_edit(self)

register_vm(self, strVmDirPath, bNonInteractiveMode=False)

create_vm(self)

get_vm_list(self)

subscribe_to_host_statistics(self)

unsubscribe_from_host_statistics(self)

init(self, handle=0)
(Constructor)