Skip to main content
Matrix42 Self-Service Help Center

Reference: Matrix42 Remote Desktop Gateway Controller Command Line Interface

Summary

The Matrix42 Remote Desktop Gateway offers a command-line tool which allows to perform administrative task e.g. update, restart or remove actions. The following document is the reference of the command line tool: 

Usage: m42-gateway <<command>> [options]

Commands

Command: start

The start command allows to start the gateway service on the underlying machine. When the services are running the controller is doing nothing. In the case that just a couple services are running the controller starts all non running services. 

m42-gateway start

Command: stop

The stop command allows to stop the gateway service on the underlying machine. When the services are not running the controller is doing nothing. In the case that just a couple services are running the controller stops all not stopped services.

m42-gateway stop

Command: restart 

The restart command combines the stop and start command and is available just for convenience reasons. 

m42-gateway restart 

Command: clean 

The clean command stops all running services and unregisters all containers. This task should only be executed when an existing server should be cleaned up totally. After that the setup procedure needs to be executed again. 

m42-gateway clean 

Command: setup 

The setup command starts the announcement process to initialize a trustworthy relationship between the remote desktop appliance and MyWorkspace. The command requires the TenantId. Please follow the getting started guide to get detailed information how to retrieve the TenantId.

m42-gateway setup <<TENANTD>>