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_AddVirtualNetwork	Adds a new virtual network.
	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_CheckParallelsServerAlive	Determines if the Parallels Service on the specified host is running and allows to retrieve its connection information.
	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_ConfigureGenericPci	Configure hardware generic PCI devices.
	PrlSrv_Create	Creates a new handle of type PHT_SERVER.
	PrlSrv_CreateVm	Obtains a new handle of type PHT_VIRTUAL_MACHINE.
	PrlSrv_CreateVmBackup	Backup an existing virtual machine to backup server.
	PrlSrv_DeleteVirtualNetwork	Deletes an existing virtual network.
	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_GetBackupTree	Get backups tree from backup server.
	PrlSrv_GetCommonPrefs	Returns a handle of type PHT_DISP_CONFIG containing the specified Parallels Service preferences information.
	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_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_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_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_GetVmList	Retrieves a list of virtual machines registered with the specified Parallels Service.
	PrlSrv_IsConnected	Determines if the connection to the specified Parallels Service is active.
	PrlSrv_IsNonInteractiveSession	Determines if the session is noninteractive or interactive.
	PrlSrv_Login	Performs a remote login operation using the specified parameters.
	PrlSrv_LoginLocal	Allows to log in to the local Parallels Service (the Parallels Service running on this host) using the current user credentials.
	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_RegEventHandler	Registers an event handler.
	PrlSrv_RegisterVm	Registers an existing virtual machine with Parallels Service.
	PrlSrv_RegisterVmEx	Registers an existing virtual machine with Parallels Service.
	PrlSrv_RemoveVmBackup	Remove backup of the virtual machine from backup server.
	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_SetNonInteractiveSession	Sets the session in noninteractive or interactive mode.
	PrlSrv_Shutdown	Shuts down the Parallels Service.
	PrlSrv_StartSearchVms	Searches for unregistered virtual machines at the specified location(s).
	PrlSrv_SubscribeToHostStatistics	Allows to subscribe to receive host OS statistics on a periodic basis.
	PrlSrv_SubscribeToPerfStats	Allows to subscribe to periodicaly 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_UpdateLicense	Installs Parallels license on the specified Parallels Service.
	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