Main Content

mps-portal

R2026b

Manage server instance from command line on Windows, Linux, and macOS systems

Since R2026b

Syntax

mps-portal command [-C [path/]server_name]

Description

mps-portal command [-C [path/]server_name] Runs a command on the specified server instance.

Input Arguments

-C path/

Specify a path to the server instance.

If you omit this option, the system searches the current working folder and its parents to find the server instance. If you have a server instance in the current working folder, you do not need to specify a full path. Specify the server name only.

server_name

Name of the server.

command

Command to run on the server instance. mps-portal supports the following commands:

  • setup sets the location of the MATLAB® Runtime and other start up options for server instances.

  • start starts a server instance.

  • stop stops a server instance, closing the HTTP server socket and all open client connections immediately. When you issue mps-stop, all function requests that the server was executing are allowed to complete before the server shuts down.

  • restart stops a server instance, then restarts the same server instance. Issuing restart is equivalent to issuing the stop and start commands in succession.

  • status displays the status of the server (STARTED, STOPPED), along with a full path to the server instance.

Examples

expand all

Start a server instance named server_1, located in folder tmp.

Type the following at the system command prompt:

mps-portal start -C /tmp/server_1

Stop a server instance named server_1, located in folder tmp.

Type the following at the system command prompt:

mps-portal stop -C /tmp/server_1

Stop a server instance named server_1, located in folder tmp.

Type the following at the system command prompt:

mps-portal restart -C /tmp/server_1

Check the status of a server instance named server_1, located in folder tmp.

Type the following at the system command prompt:

mps-portal status -C /tmp/server_1

Version History

Introduced in R2026b