startjobmanager

Start job manager process

Syntax

startjobmanager
startjobmanager -flags


Description

startjobmanager starts a job manager process and the associated job manager lookup process under the mjs service, which maintains them after that. The job manager handles the storage of jobs and the distribution of tasks contained in jobs to MATLAB^® workers that are registered with it. The mjs service must already be running on the specified computer.

The startjobmanager 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.

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

Flag	Operation
-name <job_manager_name>	Specifies the name of the job manager. This identifies the job manager to MATLAB worker sessions and MATLAB clients. The default is the value of the DEFAULT_JOB_MANAGER_NAME parameter in the mjs_def file.
-remotehost <hostname>	Specifies the name of the host where you want to start the job manager and the job manager lookup process. If omitted, they start on the local host.
-clean	Deletes all checkpoint information stored on disk from previous instances of this job manager before starting. This cleans the job manager so that it initializes with no existing jobs or tasks.
-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.
-certificate <path_to_certificate_file>	Specifies the path to the certificate file to use to connect to the job manager. You must use this flag when the mjs_def file of the job manager sets REQUIRE_CLIENT_CERTIFICATE to true.
-useMSMPI	Use Microsoft® MPI (MS-MPI) for clusters on Windows platforms.
-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
-metricsPort <port_number>	Specify the port the job manager uses to export metrics. The default port is the value of METRICS_PORT in the mjs_def file. (since R2024b)
-v	Verbose mode displays the progress of the command execution.

Examples

Start the job manager MyJobManager on the local host.

startjobmanager -name MyJobManager

Start the job manager MyJobManager on the host JMHost.

startjobmanager -name MyJobManager -remotehost JMHost