Main Content

startjobmanager

R2026b

Start job manager process

After starting the mjs service on a node, use the startjobmanager script to launch a job manager on that node. The job manager is the central process that accepts jobs from clients, manages the job queue, and distributes tasks to workers registered with it.

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

Syntax

startjobmanager
startjobmanager --options

Description

startjobmanager starts a job manager process and its associated job manager lookup process under the mjs service. The mjs service must already be running on the target computer.

startjobmanager --options accepts the following input options. You can use multiple options together on the same command. Precede each option with two dashes (--).

Before R2026b: To specify an option, use a single dash (-).

OptionOperation
--name <job_manager_name>

Specify the job manager name. MATLAB® workers and clients use this name to identify the job manager. The default is the value of the DEFAULT_JOB_MANAGER_NAME parameter in the mjs_def file.

--clean

Delete all checkpoint information stored on disk from previous instances of the job manager with the same name before starting a new job manager instance. The new job manager starts with no existing jobs or tasks.

--cleanPreserveJobsDelete checkpoint information from previous instances of the job manager with the same name, but preserve existing jobs and tasks.
--certificate <path_to_certificate_file>

Before R2026b: Specify the path to the certificate file to use to connect to the job manager. You must use this option when you set REQUIRE_CLIENT_CERTIFICATE=true in the mjs_def file on the job manager node.

--waitForWorkersSpecify the minimum number of workers that must register before the job manager begins processing jobs. The job manager remains paused until at least this many workers have registered.
--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)

--remotehost <hostname>Specify the host on which to start the job manager and the job manager lookup process. If you do not specify a host, both processes start on the local host.
--baseport <port_number>

Specify the base port used by the mjs service on the remote host. Use this option only when the remote host's base port differs from the local BASE_PORT value in the mjs_def file.

--secretfile <path_to_shared_secret_file>

Specify the path to the shared secret file to use to sign the command. This option is required when the mjs_def file of the mjs service has REQUIRE_SCRIPT_VERIFICATION=true. If you do not use this option and the mjs services requires script verification, the command attempts to use the secret file in the default location:

$CHECKPOINTBASE/security/secret

--verbose, -v

Display detailed progress information about the command execution.

Examples

Start the job manager named MyJobManager on the local host.

startjobmanager --name MyJobManager

Start the job manager named MyJobManager on the host JMHost.

startjobmanager --name MyJobManager --remotehost JMHost

Start the job manager named MyJobManager on the local host and wait for at least 4 workers to register before processing the queue.

startjobmanager --name MyJobManager --waitForWorkers 4