PHT_SERVER

At the root of the Parallels API class hierarchy is a handle of type PHT_SERVER. The handle can be obtained using the PrlSrv_Create function. The PHT_SERVER handle is required to use most of the functionality within the Parallels API.

Functions

	Name	Description
	PrlSrv_ActivateInstalledLicenseOffline	Offline activation of installed Parallels license.
	PrlSrv_ActivateInstalledLicenseOnline	Online activation of installed Parallels license.
	PrlSrv_ActivateTrialLicense	Activation of trial Parallels license.
	PrlSrv_AddIPPrivateNetwork	Adds a new private network to the Parallels Service configuration.
	PrlSrv_AddNetAdapter	Adds a new virtual network adapter to the specified Parallels Service.
	PrlSrv_AddVirtualNetwork	Adds a new virtual network to the Parallels Service configuration.
	PrlSrv_AfterHostResume	Performs to wake up generic PCI devices after host resume.
	PrlSrv_AttachToLostTask	The PrlSrv_AttachToLostTask function allows to obtain a handle to a running task after the connection to the Parallels Service was lost.
	PrlSrv_CancelInstallAppliance	Cancels the appliance installation previously started with the PrlSrv_InstallAppliance function call.
	PrlSrv_CheckParallelsServerAlive	Determines if the Parallels Service on the specified host is running and allows to retrieve its connection information.
	PrlSrv_CheckParallelsServerAliveEx	The same functionality as previos version of call except follow things: provides asynch interface; using TCP connection instead of UDP.
	PrlSrv_CommonPrefsBeginEdit	The PrlSrv_CommonPrefsBeginEdit function is used in modifying Parallels Service preferences (see PHT_DISP_CONFIG).
	PrlSrv_CommonPrefsCommit	The PrlSrv_CommonPrefsCommit function is used in modifying Parallels Service preferences (see PHT_DISP_CONFIG).
	PrlSrv_CommonPrefsCommitEx
	PrlSrv_ConfigureGenericPci	Configures the PCI device assignment.
	PrlSrv_CopyCtTemplate	Copy the specified Containers template to the specified server.
	PrlSrv_Create	Creates a new handle of type PHT_SERVER.
	PrlSrv_CreateDesktopControl	Creates Desktop Control object.
	PrlSrv_CreateUnattendedCd	Creates a bootable ISO-image for unattended Linux installation.
	PrlSrv_CreateVm	Obtains a new handle of type PHT_VIRTUAL_MACHINE.
	PrlSrv_CreateVmBackup	Backup an existing virtual machine to backup server.
	PrlSrv_DeactivateInstalledLicense	Deactivate installed Parallels license.
	PrlSrv_DeleteNetAdapter	Removes a virtual network adapter from the Parallels Service configuration.
	PrlSrv_DeleteOfflineService	Removes an existing offline service configuration.
	PrlSrv_DeleteVirtualNetwork	Removes an existing virtual network from the Parallels Service configuration.
	PrlSrv_DisableConfirmationMode	Disable administrator confirmation mode for the session.
	PrlSrv_EnableConfirmationMode	Enable administrator confirmation mode for the session.
	PrlSrv_FsCanCreateFile	Determines if the current user has sufficient rights to create a file or a directory in the specified location on the host.
	PrlSrv_FsCreateDir	Creates a directory in the specified location on the host.
	PrlSrv_FsGenerateEntryName	Automatically generates a unique name for a new directory.
	PrlSrv_FsGetDirEntries	Retrieves information about the specified file system entry residing on the specified host computer.
	PrlSrv_FsGetDiskList	Returns a list of root directories on the host computer.
	PrlSrv_FsRemoveEntry	Removes a file system entry from the host computer.
	PrlSrv_FsRenameEntry	Renames a file system entry on the host.
	PrlSrv_GetAllHostUsers	Obtains a list of handles of type PHT_EVENT containing in its parameters information about all registered host users.
	PrlSrv_GetAudioOutputEncodingList	Returns currently supported audio output encodings both by server and client.
	PrlSrv_GetBackupTree	Get backups tree from backup server.
	PrlSrv_GetBackupVmByPath	Retrieves backupable virtual machine registered by specific path.
	PrlSrv_GetBackupVmList	Retrieves all backupable virtual machines from server.
	PrlSrv_GetCommonPrefs	Returns a handle of type PHT_DISP_CONFIG containing the specified Parallels Service preferences information.
	PrlSrv_GetCtTemplateList	Retrieves a list of Containers templates registered with the specified Parallels Service.
	PrlSrv_GetDefaultVmConfig	Obtains a new handle of type PHT_VIRTUAL_MACHINE.
	PrlSrv_GetDiskFreeSpace	Get available disk space for path.
	PrlSrv_GetDisplayEncodingList	Returns currently supported display encodings both by server and client.
	PrlSrv_GetIPPrivateNetworksList	Obtains a list of handles of type PHT_IPPRIV_NET containing information about all existing private networks.
	PrlSrv_GetLicenseInfo	Returns an object of type PHT_LICENSE containing the Parallels license information.
	PrlSrv_GetNetServiceStatus	Returns an object of type PHT_NET_SERVICE_STATUS containing the Parallels network service status information.
	PrlSrv_GetNetworkClassesList	Obtains a list of handles of type PHT_HANDLES_LIST containing the list of handles of type PHT_NETWORK_CLASS.
	PrlSrv_GetNetworkShapingConfig	Obtains the network shaping configuration.
	PrlSrv_GetNetworkShapingList	Obtains a list of network shaping entries represents the network shaping configuration.
	PrlSrv_GetOfflineServicesList	Obtains a list of handles of type PHT_OFFLINE_SERVICE containing information about all existing services.
	PrlSrv_GetPackedProblemReport	Allows to receive a packed problem report from the Parallels Service in the event of a virtual machine operation failure.
	PrlSrv_GetPerfStats	Obtains a handle of type PHT_EVENT containing the perfomance statistics.
	PrlSrv_GetPluginsList	Gets plugin list with plugin info entries.
	PrlSrv_GetProblemReport	Allows to receive a problem report from the Parallels Service in the event of a virtual machine operation failure.
	PrlSrv_GetQuestions	The PrlSrv_GetQuestions function allows to synchronously receive questions from a Parallels Service.
	PrlSrv_GetRegisteredHostsOnProxy	Do authentication on proxy server and returns list of registered hosts on this proxy.
	PrlSrv_GetRestrictionInfo	Gets restriction info.
	PrlSrv_GetServerInfo	Obtains a handle of type PHT_SERVER_INFO containing the host computer information.
	PrlSrv_GetSrvConfig	Obtains a handle of type PHT_SERVER_CONFIG containing the host configuration information.
	PrlSrv_GetStatistics	Obtains a handle of type PHT_SYSTEM_STATISTICS containing the host resource usage statistics.
	PrlSrv_GetSupportedOses	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).
	PrlSrv_GetUserInfo	Obtains a handle of type PHT_USER_INFO containing information about the specified user.
	PrlSrv_GetUserInfoList	Obtains a list of handles of type PHT_USER_INFO containing information about all known users.
	PrlSrv_GetUserProfile	Obtains a handle of type PHT_USER_PROFILE containing the profile data of the currently logged in user.
	PrlSrv_GetVirtualNetworkList	Obtains a list of handles of type PHT_VIRTUAL_NETWORK containing information about all existing virtual networks.
	PrlSrv_GetVmConfig	Get VM config by given UUID or name.
	PrlSrv_GetVmList	Retrieves a list of virtual machines registered with the specified Parallels Service.
	PrlSrv_GetVmListEx	Retrieves a list of virtual machines registered with the specified Parallels Service.
	PrlSrv_HasRestriction	Determines having restriction.
	PrlSrv_InstallAppliance	Sends an appliance configuration to the Parallels Service in order to install the corresponding appliance from Parallels download service.
	PrlSrv_InstallLicenseOffline	Offline activation of Parallels license.
	PrlSrv_IsConfirmationModeEnabled	Determines confirmation mode for the session
	PrlSrv_IsConnected	Determines if the connection to the specified Parallels Service is active.
	PrlSrv_IsFeatureSupported	Checks whether specified feature supported by remote side.
	PrlSrv_IsNonInteractiveSession	Determines if the session is noninteractive or interactive.
	PrlSrv_IsProxyConnection	Determines if the connection to the specified Parallels Service is a proxy connection.
	PrlSrv_Login	Performs a remote login operation using the specified parameters.
	PrlSrv_LoginEx
	PrlSrv_LoginLocal	Allows to log in to the local Parallels Service (the Parallels Service running on this host) using the current user credentials.
	PrlSrv_LoginLocalEx
	PrlSrv_LoginLocalWithParams	Performs a login operation to local host Parallels Service using the specified parameters.
	PrlSrv_LoginWithParams	Performs a remote login operation using the specified parameters.
	PrlSrv_Logoff	Logs off the Parallels Service.
	PrlSrv_LookupParallelsServers	Searches the network for running Parallels Services and returns a handle of type PHT_SERVER_INFO for every Parallels Service that it finds.
	PrlSrv_NetServiceRestart	Restarts the Parallels network service.
	PrlSrv_NetServiceRestoreDefaults	Restores the default settings of the Parallels network service.
	PrlSrv_NetServiceStart	Starts the Parallels network service.
	PrlSrv_NetServiceStop	Stops the Parallels network service.
	PrlSrv_PrepareForHibernate	Stands by all guests with generic PCI devices.
	PrlSrv_ProxyLogin	Performs a remote proxy login operation using the specified parameters.
	PrlSrv_ProxyLoginEx
	PrlSrv_RefreshPlugins	Refreshes states of installed parallels plugins.
	PrlSrv_RefreshServerInfo	Update server info
	PrlSrv_RegEventHandler	Registers an event handler.
	PrlSrv_Register3rdPartyVm	Registers an existing 3rd party virtual machine with Parallels Service.
	PrlSrv_RegisterVm	Registers an existing virtual machine with Parallels Service.
	PrlSrv_RegisterVmEx	Registers an existing virtual machine with Parallels Service.
	PrlSrv_RegisterVmWithParams	Registers an existing virtual machine with specified params.
	PrlSrv_RegisterVmWithUuid	Registers an existing virtual machine with custom Vm UUID.
	PrlSrv_RemoveCtTemplate	Removes the specified Containers template.
	PrlSrv_RemoveIPPrivateNetwork	Removes an existing private network from the Parallels Service configuration.
	PrlSrv_RemoveVmBackup	Remove backup of the virtual machine from backup server.
	PrlSrv_RestartNetworkShaping	@section Traffic Accounting/Shaping operations //////////////////////////////////////////////////////////////////////////// Shaping configuration changed, apply new configuration to all running VMs.
	PrlSrv_RestoreVmBackup	Restore backup of the virtual machine from backup server.
	PrlSrv_SendAnswer	Sends an answer to the Parallels Service in response to a question.
	PrlSrv_SendClientStatistics	Sends Client statistic data to server.
	PrlSrv_SendProblemReport	Requests a server to send a problem report with possibility to append also the problem report assemblied at the client's side.
	PrlSrv_SetCertificateRevocationDateTime	Sets the revocation date time for SSL certificates, used in trusted channel connection.
	PrlSrv_SetGlobalDateTime	Sets the current trusted time, that will be used for SSL certificate check.
	PrlSrv_SetNonInteractiveSession	Sets the session in noninteractive or interactive mode.
	PrlSrv_SetVNCEncryption	Set VNC encryption.
	PrlSrv_Shutdown	Shuts down the Parallels Service.
	PrlSrv_ShutdownEx
	PrlSrv_SmcGetRuntimeInfo	Performs retrieving dispatcher runtime information command to server.
	PrlSrv_StartClusterService	Start HA service by service name
	PrlSrv_StartConvertHdd	Performs begin start hard disks conversions to the server side.
	PrlSrv_StartSearchVms	Searches for unregistered virtual machines at the specified location(s).
	PrlSrv_StopClusterService	Stop HA service by service name
	PrlSrv_StopInstallAppliance	Stops the appliance installation previously started with the PrlSrv_InstallAppliance function call.
	PrlSrv_StoreValueByKey	Private function to store value by specified keys on server To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function.
	PrlSrv_SubscribeToHostStatistics	Allows to subscribe to receive host OS statistics on a periodic basis.
	PrlSrv_SubscribeToPerfStats	Allows to subscribe to periodically receive perfomance statistics.
	PrlSrv_UnregEventHandler	Unregisters the specified event handler (callback function) that was previously registered with the PrlSrv_RegEventHandler function.
	PrlSrv_UnsubscribeFromHostStatistics	Cancels the Parallels Service statistics subscription that was started using the PrlSrv_SubscribeToHostStatistics function.
	PrlSrv_UnsubscribeFromPerfStats	Cancels the Parallels Service perfomace statistics subscription that was started using the PrlSrv_SubscribeToPerfStats function.
	PrlSrv_UpdateIPPrivateNetwork	Updates parameters of an existing private network.
	PrlSrv_UpdateLicense	Installs Parallels license on the specified Parallels Service.
	PrlSrv_UpdateLicenseEx
	PrlSrv_UpdateNetAdapter	Updates an existing virtual network adapter in the specified Parallels Service.
	PrlSrv_UpdateNetworkClassesList	Update network class classes configuration.
	PrlSrv_UpdateNetworkShapingConfig	Update the network shaping configuration.
	PrlSrv_UpdateNetworkShapingList	Update the list of network shaping entries represents the network shaping configuration.
	PrlSrv_UpdateOfflineService	Add/Updates parameters of an offline management service.
	PrlSrv_UpdateSessionInfo	Updates parameters of opened session.
	PrlSrv_UpdateUsbDevicesAssociationsList	Updates internal Parallels client USB associations list.
	PrlSrv_UpdateVirtualNetwork	Updates parameters of an existing virtual network.
	PrlSrv_UserProfileBeginEdit	Timestamps the beginning of the user profile editing operation.
	PrlSrv_UserProfileCommit	Saves (commits) user profile changes to the Parallels Service.

Links

Functions, Functions by Handle, Legend