Command Line

Command Line

Advanced >

Royal TS has extensive command line support. Using command line parameters you can:

 

Note

Open a command prompt (cmd.exe) enter RoyalTS.exe /? to see command line usage, options and examples. RoyalTS.exe is usually found in C:\Program Files (x86)\Royal TS V5.

The default protocol parameter is RDP. If you are specifying a connection other than RDP, make sure you include the correct protocol.

 

Usage:

RoyalTS.exe [<filename>] [/action:connect|disconnect] [/protocol:<identifier>]

            [/using:uri|name|id|adhoc] [/uri:ip|objectname|objectid]

            [/usingtemplate:name|id] [/template:templatename|templateid]

            [(/username:<username> /password:<password>) | /credential:<name>]

            [/property:<name>=<value>]*

            [/donotactivate]

 

RoyalTS.exe /resetlayout

RoyalTS.exe /resettoolbar

RoyalTS.exe /startscan

RoyalTS.exe /stopscan

 

Options:

    <filename>      Specifies the file to be opened.

    /action         Action to execute [connect|disconnect, default: connect].

    /protocol       Protocol identifier. e.g. rdp, web, terminal [default:rdp].

    /using          Search for existing object by uri, name, id or create a new

                    ad hoc connection.

    /uri            Computer name, ip address, object name or object id.

    /usingtemplate  Search for existing template by name or id.

    /template       Template name or id.

    /username       Provide a user name for /using:adhoc.

    /password       Provide a password for /using:adhoc.

    /credential     Provide a credential name for /using:adhoc

    /property       Provide one or more property values for /using:adhoc.

    /donotactivate  Main window will not be activated.

    /resetlayout    Resets all layout information for panels.

    /resettoolbar   Resets all toolbar customizations.

    /startscan      Activates the tab scan feature.

    /stopscan       Deactivates the tab scan feature.

 

You can also use URI schemes to open connections. For example:

  rtsx://rdp://192.168.1.16?using=adhoc&credential=admin

 

Consult documentation for more information.

 

 

Examples:

RoyalTS.exe server.rtsz

    Opens the file 'server.rtsz'

 

RoyalTS.exe /protocol:web /using:adhoc /uri:google.com

    Connects to a newly created ad hoc web page connection loading google.com.

 

RoyalTS.exe /protocol:terminal /using:uri /uri:192.168.1.15

    Connects to the terminal connection with the computer name 192.168.1.15.

 

RoyalTS.exe /action:disconnect /protocol:rdp /using:name /uri:"Web Server 1"

    Disconnects the remote desktop connection with the name "Web Server 1".

 

RoyalTS.exe /using:adhoc /uri:192.168.1.16 /property:ColorDepth=8

            /property:Description="""Came from command-line"""

    Connects to a newly created ad hoc remote desktop connection to 192.168.1.16

    with the color depth set to 8 bit and a custom description.

 

RoyalTS.exe /using:adhoc /uri:192.168.1.16

            /usingtemplate:name /template:"iLO Web"

    Connects to a newly created ad hoc connection  using a template

    with name "iLO Web" and with the URI 192.168.1.16.