Previous page

Next page

Locate page in Contents

Parallels Client URL Scheme

Parallels RAS uses the following URL schemes to perform actions in Parallels Client installed on end user devices:

  • prlclient:// — the scheme that is currently used in Parallels RAS (RAS v15.5 and later versions).
  • tuxclient:// — this is a legacy scheme kept for backward compatibility with older versions of Parallels Client.

The actions that can be performed in Parallels Client include the following:

  • Configure a Parallels RAS or RDS connection using specific settings.
  • Launch a remote application by specifying the host, the application itself, and some other parameters.

Parallels Client URL schemes are supported on the following platforms:

  • Windows
  • macOS
  • Linux
  • iOS
  • Android

Parallels RAS uses URL schemes in invitation emails and in the HTML5 Client. For more information, see Invite Users and Launching Remote Applications and Desktops.

The following table can be used as a reference to parameters used in a Parallels Client URL:

Key

Datatype

Value

Command

String

"LaunchApp"

This tells Parallels Client that the intent is to create a connection and / or launch a published resource.

AppID

Int

The application ID to launch (the ID is displayed in the Publishing category in the Parallels RAS Console). If this parameter is empty, Parallels Client will only list the available resources.

Alias

String

A connection name (when creating a new connection).

ConnType

Int

Connection type:

  • 2 — Standard RDP Connection
  • 0 — Parallels RAS Connection

ConnMode

Int

Connection mode:

  • 0 — Gateway
  • 1 — Direct
  • 2 — Gateway SSL
  • 3 — Direct SSL

Server

String

The server FQDN or IP address.

Backup

String

The secondary connection server (if available and required).

Port

Int

The port number.

UserName

String

User name. If this parameter is empty, the user will be prompted to enter a name when connecting to Parallels RAS.

EncPass

String

Encrypted ('hashed') password. If not specified, a user will be prompted for password when connecting.

SessionID

String

The Auth Session ID.

Connect

Boolean

Whether to connect to Parallels RAS right after the connection is configured.

Save

Boolean

Whether to save the connection settings in Parallels Client.

Request Page

String

Used by HTML5 Client to obtain information from Parallels Client.

SSO

String

[Optional] Custom 3rd party SSO GUID. Used only by Windows clients. Currently only used by invitation emails.

HelpDeskEmail

String

[Optional] Help desk/support contact email. Currently only used by Android and iOS clients.

OverrideArgs

String

Override application parameters. Currently only used by Mac client.

Example:

prlclient:///?Command=LaunchApp&AppID=2360&Alias=Leonardo+IPv4&ConnType=0&ConnMode=0&Server=10.125.0.50&Backup=&Port=80&UserName=tester56%402x&EncPass=l6Y1%2bfOryvNHYsI0nWIW4g%3d%3d&SessionID=A78399FE-7077-43AD-8D0A-03641F1C759B&Connect=YES&Save=NO&RequestPage=http://leonardo.2x.testing/2xwebportal/Dashboard.aspx
Top of page Feedback