Starting RoboServer

RoboServer can be started in several different ways:

To invoke RoboServer from the command line, open up a command window and type:


followed by Enter. If you have installed RoboServer correctly as described in the Installation Guide, then the following is printed in the command window after which RoboServer terminates:

Detected the following plugins:

Usage: RoboServer [-maxClippingSessions <num>] [-verbose] [-version] [-MC] [-port] [-sslPort] [-help] -service <service:params>

Available services:


RoboServer Help Text

The dots indicate information that depends on your installation. If something different than the above is printed in the command window, then please confirm that you have installed RoboServer as described in the Installation Guide.


The command below starts a RoboServer and that accepts socket connections to the Socket-based RQL Service listening on port number 50000.

                RoboServer -p 50000

RoboServer Parameters

No matter how RoboServer is started, it accepts the following parameters:



-c <num> |
-maxClippingSessions <num>


This parameter specifies the maximum number of clipping sessions that can exist on this RoboServer. This parameter is optional. The default value is 50. The minimum value is 0.

Example: -maxClippingSessions 20

-v |


This optional parameter causes RoboServer to output status and runtime events.

-V |


This optional parameter causes RoboServer to output the version number, and then exit.



This optional parameter triggers the Management Console to be started as part of RoboServer. The Management Console runs on an embedded web server configured through the Settings application.

-s <service-name:service-parameter> |
-service <service-name:service-parameter>


This parameter specifies a RQL or JMX service that RoboServer should start. This parameter must be specified at least once, and may be specified multiple times to start multiple services in the same RoboServer. The available services depend on your installation.

Example: -service socket:50000

Example: -service jmx:50100

-p <port-number> |
-port <port-number>


This is a shorthand for calling -s socket:<port-number>

Example: -port 50000

-P <port-number> |
-sslPort <port-number>


This is a shorthand for calling -s ssl:<port-number>

Example: -sslPort 50001

RoboServer Parameters

There is no required ordering of the parameters. The JMX service provides management information from the RoboServer on the specified port.

Shutting Down RoboServer

RoboServer can be shut down using the command line tool ShutDownRoboServer. Run ShutDownRoboServer without arguments to see the various options for how to shut down the server, in particular how to handle any robots that are currently running on the server.