Starting a session from the command line

Syntax

RumbaPage.exe <path>\<session_desktop_profile> /Display:MFrame /Host:<IP_or_host_name> /Port:<port_number> /forcenewinstance

where:

<path>
is the absolute path to a saved session or desktop profile. Only required when specifying a profile.
<session_desktop_profile>
The name of a saved session or desktop profile. Optional.
Display
specifies the type of session. Currently supports only MFrame. Optional.
<IP_or_host_name>
specifies the IP address or name of the host to connect to. Can only be used with /Display:MFrame for which it is required.
<port_number>
the port number to connect to. Can only be used with /Display:MFrame for which it is required.
forcenewinstance
forces a new Rumba instance to start. Optional.
Notes:
  • If there is a syntax error or if a required parameter is not supplied, Rumba starts as if no parameters were supplied.
  • Session profiles and desktop profiles cannot be set to Auto-Connect. If such a profile is specified, an error occurs and all parameters are ignored.
  • If a desktop profile is specified, Display, Host, and Port must not be used. Otherwise, an error occurs and all parameters are ignored.

Examples

RumbaPage.exe /Display:MFrame /Host:<IP_or_host_name> /Port:<port_number>

Starts a default session and attempts to connect to the specified host and port.

RumbaPage.exe <path>\<session_profile> /Display:MFrame /Host:<IP_or_host_name> /Port:<port_number>

Opens the specified session profile (including all keyboard mapping and color settings) and attempts to connect to the specified host and port.

RumbaPage.exe <path>\<desktop_profile>

Opens the specified desktop profile.