URI Scheme |
![]() |
Royal TS can be invoked using a URI scheme using the following syntax:
rtsx://<protocol-identifier>%3a%2f%2f[[email protected]]<uri>?action=<connect|disconnect>&using=<uri|name|id|adhoc>
&username=<username>&password=<password>&credential=<name>&property_<name>=value&donotactivate=<true>
This can be useful to embed links into intranet pages or invoke Royal TS connections from external applications.
Parameter |
Description |
Remarks |
protocol-identifier |
Specify the protocol identifier or an alias for the connection type you want to connect to. A list of available protocol identifiers can be found here. |
This parameter is required. |
credential-name |
Specify the credential name. |
This parameter is optional. |
uri |
Depending on the using parameter, provide one of the following as URI: using=uri: computer name or ip address using=name: object name using=id: the ID (Guid) of the object using=adhoc: the computer name or ip address |
This parameter is required. Make sure the URI parameter is URL encoded when blanks or other special characters are used. |
action |
Action to execute: connect or disconnect. |
This parameter is optional. Default value is connect. |
using |
Search for existing object by uri, name, id or create a new ad hoc connection. |
This parameter is optional. Default is adhoc. |
username |
Provide a user name. |
This parameter is optional and can only be used for using=adhoc connections. |
password |
Provide a password. |
This parameter is optional and can only be used for using=adhoc connections. |
credential |
Provide a credential name. |
This parameter is optional and can only be used for using=adhoc connections. |
property_<name> |
Provide one or more property values. |
This parameter is optional and can only be used for using=adhoc connections. For detailed information about properties and their values, visit Object Properties chapter in the scripting reference |
donotactivate |
Main window will not be activated. |
This parameter is optional. |
Note |
The protocol-identifier must be terminated with the URL encoded :// characters (%3a%2f%2f). Make sure that special characters in the credential name or URI must be URL encoded as well. |
Examples:
rtsx://rdp%3a%2f%2f192.168.5.16?using=uri
Connects to the remote desktop connection with the computer name 192.168.5.16.
rtsx://rdp%3a%2f%[email protected]
Connects to an ad hoc remote desktop connection to 192.168.5.16 using the credential with the name admin.
rtsx://rdp%3a%2f%[email protected]%20Server%201?using=name
Connects to an existing remote desktop connection named "Web Server 1" (without the quotes)
using the credential with the name admin.
rtsx://rdp%3a%2f%2fWeb%20Server%201?using=name&action=disconnect
Disconnects the remote desktop connection named "Web Server 1" (without the quotes).
rtsx://filetransfer%3a%2f%2f3c74baad-8303-47cd-a2d5-7dc40975acdc?using=id
Connects to the file transfer connection with the specified id.
rtsx://rdp%3a%2f%2f192.168.5.16?using=adhoc&action=connect&property_Description=Connected%20using%20URI&property_ColorDepth=8
Connects to an ad hoc remote desktop connection with the computer name 192.168.5.16
and sets the property Description to "Connected using URI" and the property ColorDepth to 8 bit.