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.
|
__init__(self,
handle=0)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
|
|
|
|
|
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. |
|
|
|
|
|
|
|
common_prefs_begin_edit(self)
Virtual Machine-based servers only Mark the beginning of the
Parallels Service preferences modification operation. |
|
|
|
|
|
common_prefs_commit_ex(self,
hDispCfg,
nFlags) |
|
|
|
|
|
|
|
|
|
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_config(self,
hNetworkShapingConfig,
nFlags) |
|
|
|
get_network_shaping_config(self,
nFlags) |
|
|
|
|
|
|
|
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. |
|
|
|
|
|
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). |
|
|
|
register_vm_with_uuid(self,
strVmDirPath,
strVmUuid,
nFlags) |
|
|
|
register3rd_party_vm(self,
strVmConfigPath,
strVmRootDirPath,
nFlags)
Virtual Machine-based servers only Registers an existing 3rd
party virtual machine with Parallels Service. |
|
|
|
create_vm(self)
Create a new instaince of the Vm class. |
|
|
|
get_vm_list(self)
Obtain a list of virtual machines from the host. |
|
|
|
get_vm_list_ex(self,
nFlags) |
|
|
|
get_default_vm_config(self,
nVmType,
sConfigSample,
nOsVersion,
nFlags) |
|
|
|
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,
sUuid,
sTargetHost,
nTargetPort,
sTargetSessionId,
backup_flags=2048,
reserved_flags=0,
force_operation=True)
Obtain a backup tree from the 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. |
|
|
|
|
|
|
|
shutdown(self,
bForceShutdown=False)
Shut down the Parallels Service. |
|
|
|
shutdown_ex(self,
nFlags) |
|
|
|
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. |
|
|
|
update_license_ex(self,
sKey,
sUser,
sCompany,
nFlags) |
|
|
|
|
|
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_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)
Virtual Machine-based servers only Extracts supported guest
OSes matrix from remote server (it's more proper way instead of using
local synch API in case when client and server interoperate
remotely). |
|
|
|
create_unattended_cd(self,
nGuestType,
sUserName,
sPasswd,
sFullUserName,
sOsDistroPath,
sOutImagePath)
Virtual Machine-based servers only 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)
Virtual Machine-based servers only Sends an appliance
configuration to the Parallels Service in order to install the
corresponding appliance |
|
|
|
cancel_install_appliance(self,
hAppCfg,
nFlags)
Virtual Machine-based servers only Cancels the appliance
installation previously started with the PrlSrv_InstallAppliance ( p. |
|
|
|
stop_install_appliance(self,
hAppCfg,
nFlags)
Virtual Machine-based servers only Stops the appliance
installation previously started with the PrlSrv_InstallAppliance function call. |
|
|
|
get_ct_template_list(self,
nFlags)
Container-based servers only Retrieves a list of Containers
templates registered with the specified Parallels Service. |
|
|
|
remove_ct_template(self,
sName,
sOsTmplName,
nFlags)
Container-based servers only Removes the specified Containers
template. |
|
|
|
copy_ct_template(self,
sName,
sOsTmplName,
sTargetServerHostname,
nTargetServerPort,
sTargetServerSessionUuid,
nFlags,
nReservedFlags)
Container-based servers only Copy the specified Containers
template to the specified server. |
|
|
|
is_feature_supported(self,
nFeatureId) |
|
|
|
add_ipprivate_network(self,
hPrivNet,
nFlags) |
|
|
|
remove_ipprivate_network(self,
hPrivNet,
nFlags) |
|
|
|
update_ipprivate_network(self,
hPrivNet,
nFlags) |
|
|
|
get_ipprivate_networks_list(self,
nFlags) |
|
|
|
refresh_plugins(self,
nFlags)
Virtual Machine-based servers only Refreshes states of
installed parallels plugins. |
|
|
|
get_plugins_list(self,
sClassId,
nFlags)
Virtual Machine-based servers only Gets plugin list with
plugin info entries. |
|
|
|
login_ex(self,
host,
user,
passwd,
sPrevSessionUuid,
port_cmd,
timeout,
security_level,
flags) |
|
|
|
login_local_ex(self,
sPrevSessionUuid,
port,
security_level,
flags) |
|
|
|
get_disk_free_space(self,
sPath,
nFlags) |
|
|
|
create_desktop_control(self) |
|
|
|
get_vm_config(self,
sSearchId,
nFlags) |
|
|
|
set_vncencryption(self,
sPubKey,
sPrivKey,
nFlags) |
|
|
Inherited from _Handle :
__del__ ,
add_ref ,
free ,
get_handle_type ,
get_package_id ,
get_type
Inherited from object :
__delattr__ ,
__format__ ,
__getattribute__ ,
__hash__ ,
__new__ ,
__reduce__ ,
__reduce_ex__ ,
__repr__ ,
__setattr__ ,
__sizeof__ ,
__str__ ,
__subclasshook__
|