stopworker - Stop MATLAB worker session - MATLAB (original) (raw)
Main Content
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.
| Flag | Operation |
|---|---|
| -name <worker_name> | Specifies the name of the MATLAB worker to stop. The default is the value of theDEFAULT_WORKER_NAME parameter in themjs_def file. |
| -remotehost | 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 ofBASE_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 ofSHARED_SECRET_FILE in the local mjs_def file. If not specified, the command will attempt to use the path in the localmjs_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.
Stop the worker with the default name, running on the computerWorkerHost.
stopworker -remotehost WorkerHost
Stop the workers named worker1 and worker2, running on the computerWorkerHost.
stopworker -name worker1 -remotehost WorkerHost stopworker -name worker2 -remotehost WorkerHost