Main Content

stopworker

Stop MATLAB worker session

Syntax

stopworker
stopworker -flags

Description

stopworker stops a MATLAB® worker process that is running under the mjs service.

The stopworker executable resides in the folder matlabroot\toolbox\parallel\bin (Windows® operating system) or matlabroot/toolbox/parallel/bin (UNIX® operating system). Enter the following command syntax at a Windows or UNIX command-line prompt, respectively.

stopworker -flags accepts the following input flags. Multiple flags can be used together on the same command.

FlagOperation
-name <worker_name>

Specifies the name of the MATLAB worker to stop. The default is the value of the DEFAULT_WORKER_NAME parameter in the mjs_def file.

-remotehost <hostname>

Specifies the name of the host where you want to stop the MATLAB worker. The default value is the local host.

-clean

Deletes all checkpoint information associated with this worker name after stopping it.

-baseport <port_number>

Specifies the base port that the mjs service on the remote host is using. You need to specify this only if the value of BASE_PORT in the local mjs_def file does not match the base port being used by the mjs service on the remote host.

-onidle

Stops the MATLAB worker after it has finished its current task. If the MATLAB worker is idle, stops the worker immediately.

-secretfile <path_to_shared_secret_file>

Specifies the path to the shared secret file to use to authenticate the command. Use this flag to override the value of SHARED_SECRET_FILE in the local mjs_def file. If not specified, the command will attempt to use the path in the local mjs_def file or the default location:

$CHECKPOINTBASE/security/secret

-v

Verbose mode displays the progress of the command execution.

Examples

Stop the worker with the default name on the local host.

stopworker

Stop the worker with the default name, running on the computer WorkerHost.

stopworker -remotehost WorkerHost

Stop the workers named worker1 and worker2, running on the computer WorkerHost.

stopworker -name worker1 -remotehost WorkerHost 
stopworker -name worker2 -remotehost WorkerHost

See Also

| | | |